java.lang.Object
- io.github.mmm.ui.api.widget.AbstractUiWidget
- - io.github.mmm.ui.spi.widget.AbstractUiNativeWidget
  - - io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper<W>
    - - io.github.mmm.ui.fx.widget.FxWidget<W>
      - io.github.mmm.ui.fx.widget.FxWidgetStyleable<W>
        
        io.github.mmm.ui.fx.widget.FxWidgetNode<W>
        
        io.github.mmm.ui.fx.widget.FxActiveWidget<W>

Type Parameters:

W - type of JavaFx widget.

All Implemented Interfaces:

EventSource<UiEvent,UiEventListener>, AttributeReadEnabled, AttributeReadId, AttributeReadValid, AttributeReadVisible, AttributeWriteEnabled, AttributeWriteId, AttributeWriteReadOnly, AttributeWriteTooltip, AttributeWriteValidationFailure, AttributeWriteVisible, UiActiveWidget, UiNativeWidget, UiWidget, UiNativeWidgetWrapper<W>

Direct Known Subclasses:

FxActiveValidatableWidget, FxClickableWidget
```
public abstract class FxActiveWidget<W extends javafx.scene.layout.Region>
extends FxWidgetNode<W>
implements UiActiveWidget
```
Implementation of UiActiveWidget based on JavaFx Control.

Since:

1.0.0

Field Summary
- Fields inherited from class io.github.mmm.ui.fx.widget.FxWidget
  CLASS_INVALID, CLASS_READ_ONLY, widget
- Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure
  STYLE_INVALID
- Fields inherited from interface io.github.mmm.ui.api.widget.UiActiveWidget
  ACCESS_KEY_NONE

Constructor Summary

Constructors
Constructor Description

FxActiveWidget(W widget)
The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`char`	`getAccessKey()`
`boolean`	`isFocused()`
`protected void`	`registerFocusChangeHandler()`
`protected void`	`registerHandlers()`	Registers the according handlers to the underlying native widget.
`void`	`setAccessKey(char accessKey)`	This method sets the `accessKey` attribute of this object.
`boolean`	`setFocused()`	This method sets the `focus` to this widget.
`protected void`	`setParent(UiComposite<?> parent)`

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetNode
getTopWidget, setEnabledNative, setIdNative, setReadOnlyNative, setTooltipNative, setVisibleNative

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetStyleable
createStyles

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidget
getTopNode, getWidget, onAction, onClose, onFocusChange, onFocusChanged, onValueChange, onValueChanged, setTooltip, setWidget

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper
createDefaultStyles, getId, getStyles, getTooltip, onStylesChanged, setId, setTooltip

Methods inherited from class io.github.mmm.ui.api.widget.AbstractUiWidget
isEmpty, setParent, unwrap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadId
getId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteId
setId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteTooltip
getTooltip, setTooltip

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure
setValidationFailure

Methods inherited from interface io.github.mmm.event.EventSource
addListener, addListener, addWeakListener, removeListener

Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget
cast, dispose, getModificationTimestamp, getParent, getReadOnlyFixed, getStyles, isDisposed, isEnabled, isEnabled, isModified, isReadOnly, isValid, isVisible, isVisible, reset, setEnabled, setEnabled, setReadOnly, setReadOnlyFixed, setVisible, setVisible, validate, validate, validate, validateDown, validateUp

- Constructor Detail
  - FxActiveWidget
```
public FxActiveWidget(W widget)
```
    The constructor.
    
    Parameters:
    
    widget - the JavaFx widget.
- Method Detail
  - registerHandlers
```
protected void registerHandlers()
```
    Description copied from class: AbstractUiNativeWidget
    
    Registers the according handlers to the underlying native widget. Never call manually, only via AbstractUiNativeWidget.ensureHandlers().
    
    Overrides:
    
    registerHandlers in class AbstractUiNativeWidget
  - registerFocusChangeHandler
```
protected void registerFocusChangeHandler()
```
    See Also:
    
    registerHandlers()
  - setParent
```
protected void setParent(UiComposite<?> parent)
```
    Overrides:
    
    setParent in class AbstractUiNativeWidget
    
    Parameters:
    
    parent - the new parent.
  - getAccessKey
```
public char getAccessKey()
```
    Specified by:
    
    getAccessKey in interface UiActiveWidget
    
    Returns:
    
    the access key of this widget. If the access key is pressed together with the [shift] and [alt] keys this widget will be invoked means that it is clicked. If not an action item (button, link, etc.) it will get the focus. Will be UiActiveWidget.ACCESS_KEY_NONE if no access key is defined.
  - setAccessKey
```
public void setAccessKey(char accessKey)
```
    Description copied from interface: UiActiveWidget
    
    This method sets the accessKey attribute of this object.
    
    Specified by:
    
    setAccessKey in interface UiActiveWidget
    
    Parameters:
    
    accessKey - is the new value of UiActiveWidget.getAccessKey(). Use UiActiveWidget.ACCESS_KEY_NONE to unset.
  - isFocused
```
public boolean isFocused()
```
    Specified by:
    
    isFocused in interface UiWidget
    
    Returns:
    
    true if this widget is active and currently has the focus (the cursor is placed in the widget e.g. a text input and it will receive keyboard events), false otherwise.
  - setFocused
```
public boolean setFocused()
```
    Description copied from interface: UiWidget
    
    This method sets the focus to this widget. In case of a UiComposite it will set the focus to the first child capable of taking the focus.
    NOTE:
    You can only set the focus. To actually remove it, you need to set it in a different widget.
    
    Specified by:
    
    setFocused in interface UiWidget
    
    Returns:
    
    true if the focus has been set successfully, false otherwise. You can normally ignore the result. It is only relevant for composite widgets such as panels, that delegate the call recursively and may not contain any child that can take the focus.

Class FxActiveWidget<W extends javafx.scene.layout.Region>

Field Summary

Fields inherited from class io.github.mmm.ui.fx.widget.FxWidget

Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure

Fields inherited from interface io.github.mmm.ui.api.widget.UiActiveWidget

Constructor Summary

Method Summary

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetNode

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetStyleable

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidget

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidget

Methods inherited from class io.github.mmm.ui.api.widget.AbstractUiWidget

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteTooltip

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure

Methods inherited from interface io.github.mmm.event.EventSource

Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget

Constructor Detail

FxActiveWidget

Method Detail

registerHandlers

registerFocusChangeHandler

setParent

getAccessKey

setAccessKey

isFocused

setFocused