java.lang.Object
- io.github.mmm.ui.api.widget.AbstractUiWidget
- - io.github.mmm.ui.spi.widget.AbstractUiNativeWidget

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractUiNativeWidgetWrapper
```
public abstract class AbstractUiNativeWidget
extends AbstractUiWidget
implements UiNativeWidget, AttributeWriteValidationFailure
```
Abstract base implementation of UiNativeWidget.

Since:

1.0.0

Field Summary
- Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure
  STYLE_INVALID

Constructor Summary

Constructors
Constructor Description

AbstractUiNativeWidget()
The constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addListener(UiEventListener listener, boolean weak)`	Adds an `EventListener` which will be notified whenever the an event occurs (something changes).
`void`	`dispose()`	This method disposes this widget.
`protected void`	`doDispose()`	Called from `dispose()`
`protected static int`	`doGetEnabledState(AbstractUiNativeWidget widget)`
`protected static int`	`doGetVisibleState(AbstractUiNativeWidget widget)`
`protected void`	`doSetEnabledState(int state)`
`protected static void`	`doSetEnabledState(AbstractUiNativeWidget widget, int state)`
`protected void`	`doSetValidationFailure(String error)`	Called from `AttributeWriteValidationFailure.setValidationFailure(String)` if the failure actually changed.
`protected void`	`doSetVisibleState(int state)`
`protected static void`	`doSetVisibleState(AbstractUiNativeWidget widget, int state)`
`protected void`	`ensureHandlers()`	Ensures that the event handlers (adapters) are `registered`.
`protected void`	`fireEvent(UiEvent event)`
`protected EventSourceAdapter<UiEvent,UiEventListener>`	`getEventAdapter()`
`UiComposite<?>`	`getParent()`
`protected UiEventType`	`getProgrammaticEventType()`
`Boolean`	`getReadOnlyFixed()`
`String`	`getValidationFailure()`
`protected boolean`	`hasListeners()`
`boolean`	`isDisposed()`
`boolean`	`isEnabled(BitMask mask)`
`protected boolean`	`isInitiallyVisible()`
`boolean`	`isReadOnly()`
`boolean`	`isValid()`	A `UiComposite` is only valid if all its children are valid (recursive check).
`boolean`	`isVisible(BitMask mask)`
`protected boolean`	`isVisibleWithoutRoot()`
`protected void`	`registerHandlers()`	Registers the according handlers to the underlying native widget.
`boolean`	`removeListener(UiEventListener listener)`	This method removes an `EventListener`.
`protected void`	`requireNotDisposed()`	Ensures that this widget is not `disposed`.
`void`	`setEnabled(boolean enabled, BitMask mask)`
`protected abstract void`	`setEnabledNative(boolean enabled)`
`protected void`	`setParent(UiComposite<?> parent)`
`protected void`	`setProgrammaticEventType(UiEventType eventType)`
`void`	`setReadOnly(boolean readOnly)`	Switches this widget between view (read-only `true`) and edit (read-only `false`) mode.
`void`	`setReadOnlyFixed(Boolean readOnlyFixed)`	Sets a fixed `read-only` mode.
`protected abstract void`	`setReadOnlyNative(boolean readOnly)`
`void`	`setValidationFailure(String validationFailure, boolean valueException)`
`void`	`setVisible(boolean visible, BitMask mask)`
`protected abstract void`	`setVisibleNative(boolean visible)`
`protected UiNativeWidget`	`unwrap()`
`boolean`	`validateDown(UiValidState state)`	Performs `validation` without `upwards propagation`.

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, addWeakListener

Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget
cast, getModificationTimestamp, getStyles, isEnabled, isFocused, isModified, isVisible, reset, setEnabled, setFocused, setVisible, validate, validate, validate, validateUp

- Constructor Detail
  - AbstractUiNativeWidget
```
public AbstractUiNativeWidget()
```
    The constructor.
- Method Detail
  - addListener
```
public void addListener(UiEventListener listener,
                        boolean weak)
```
    Description copied from interface: EventSource
    
    Adds an EventListener which will be notified whenever the an event occurs (something changes). If the same listener is added more than once, it will be notified more than once. The same EventListener instance may be registered for different EventSources.
    
    Specified by:
    
    addListener in interface EventSource<UiEvent,UiEventListener>
    
    Parameters:
    
    listener - the EventListener to register.
    
    weak - - true if the EventListener may be garbage collected without being removed via a WeakReference, false otherwise (if the listener will be associated using a strong reference). When providing true here (use WeakReference), you need to store a reference to your registered EventListener yourself in the owning parent object so it is not garbage-collected too early.
    
    See Also:
    
    EventSource.addWeakListener(EventListener)
  - removeListener
```
public boolean removeListener(UiEventListener listener)
```
    Description copied from interface: EventSource
    
    This method removes an EventListener. If the EventListener was not registered before this method does not do any change. Otherwise the first matching EventListener will be removed. So if you added an EventListener multiple times, only the first occurrence will be removed.
    For performance reasons EventListener.isMatchedUsingEquals() returns false by default. To force the usage of equals instead, ensure your EventListener implementation overrides Object.equals(Object) and EventListener.isMatchedUsingEquals() returning true.
    
    Specified by:
    
    removeListener in interface EventSource<UiEvent,UiEventListener>
    
    Parameters:
    
    listener - is the EventListener to unregister.
    
    Returns:
    
    true if the given listener has successfully been removed, false if the listener was NOT registered.
  - hasListeners
```
protected boolean hasListeners()
```
    Returns:
    
    true if at least one EventListener is registered, false otherwise.
  - getEventAdapter
```
protected EventSourceAdapter<UiEvent,UiEventListener> getEventAdapter()
```
    Returns:
    
    the EventSourceAdapter.
  - fireEvent
```
protected void fireEvent(UiEvent event)
```
    Parameters:
    
    event - the event to send to all registered EventListeners.
  - isInitiallyVisible
```
protected boolean isInitiallyVisible()
```
    Returns:
    
    true if this widget is initially visible (locally native), false otherwise.
  - getParent
```
public UiComposite<?> getParent()
```
    Specified by:
    
    getParent in interface UiWidget
    
    Returns:
    
    the parent of this widget or null if not attached to the UI or if this is a root widget (e.g. the main window).
  - setParent
```
protected void setParent(UiComposite<?> parent)
```
    Specified by:
    
    setParent in class AbstractUiWidget
    
    Parameters:
    
    parent - the new parent.
  - isVisible
```
public boolean isVisible(BitMask mask)
```
    Specified by:
    
    isVisible in interface UiWidget
    
    Parameters:
    
    mask - the BitMask to check the visibility of. See UiVisibleFlags for available options. May be null to check all modes including the parent widget.
    
    Returns:
    
    true if visible, false if hidden.
  - isVisibleWithoutRoot
```
protected boolean isVisibleWithoutRoot()
```
    Returns:
    
    true if this is a root widget (e.g. UiMainWindow) that is visible without a parent, false otherwise.
  - setVisible
```
public void setVisible(boolean visible,
                       BitMask mask)
```
    Specified by:
    
    setVisible in interface UiWidget
    
    Parameters:
    
    visible - true to show this widget (in case its parent is also visible), false to hide this widget.
    
    mask - the BitMask to apply. See UiVisibleFlags for available options.
    
    See Also:
    
    UiWidget.isVisible()
  - setVisibleNative
```
protected abstract void setVisibleNative(boolean visible)
```
    Parameters:
    
    visible - true to show this widget (in case its parent is also visible), false to hide this widget.
  - doGetVisibleState
```
protected static final int doGetVisibleState(AbstractUiNativeWidget widget)
```
    Parameters:
    
    widget - the AbstractUiNativeWidget.
    
    Returns:
    
    the internal visible state of the given widget.
  - doSetVisibleState
```
protected final void doSetVisibleState(int state)
```
    Parameters:
    
    state - new value of doGetVisibleState(AbstractUiNativeWidget).
  - doSetVisibleState
```
protected static final void doSetVisibleState(AbstractUiNativeWidget widget,
                                              int state)
```
    Parameters:
    
    widget - the AbstractUiNativeWidget.
    
    state - new value of doGetVisibleState(AbstractUiNativeWidget) of the given widget.
  - isEnabled
```
public boolean isEnabled(BitMask mask)
```
    Specified by:
    
    isEnabled in interface UiWidget
    
    Parameters:
    
    mask - the BitMask to check the enabled state of. See UiEnabledFlags for available options. May be null to check all modes including the parent widget.
    
    Returns:
    
    true if enabled, false if disabled (end-user cannot interact with this widget or its children).
  - setEnabled
```
public void setEnabled(boolean enabled,
                       BitMask mask)
```
    Specified by:
    
    setEnabled in interface UiWidget
    
    Parameters:
    
    enabled - the new enabled state. Use true to enable and false to disable this widget.
    
    mask - the BitMask to apply. See UiEnabledFlags for available options.
    
    See Also:
    
    UiWidget.setEnabled(boolean)
  - setEnabledNative
```
protected abstract void setEnabledNative(boolean enabled)
```
    Parameters:
    
    enabled - the new enabled state. Use true to enable and false to disable this widget.
  - doGetEnabledState
```
protected static final int doGetEnabledState(AbstractUiNativeWidget widget)
```
    Parameters:
    
    widget - the AbstractUiNativeWidget.
    
    Returns:
    
    the internal enabled state of the given widget.
  - doSetEnabledState
```
protected final void doSetEnabledState(int state)
```
    Parameters:
    
    state - new value of doGetEnabledState(AbstractUiNativeWidget).
  - doSetEnabledState
```
protected static final void doSetEnabledState(AbstractUiNativeWidget widget,
                                              int state)
```
    Parameters:
    
    widget - the AbstractUiNativeWidget.
    
    state - new value of doGetEnabledState(AbstractUiNativeWidget) of the given widget.
  - isReadOnly
```
public boolean isReadOnly()
```
    Specified by:
    
    isReadOnly in interface AttributeWriteReadOnly
    
    Specified by:
    
    isReadOnly in interface UiWidget
    
    Returns:
    
    true if this widget is read-only (value can not be edited by the user and is displayed as view only like a label), false otherwise.
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
    Description copied from interface: UiWidget
    
    Switches this widget between view (read-only true) and edit (read-only false) mode. This may also have effects such that a UiButtonPanel is showing a "Save" button only in edit mode, while it shows an "Edit" button in read-only mode that switches to edit mode.
    A UiComposite will propagate the read-only state to all its children when this method is called. Please note that several widgets such as UiLabel are always read-only. In such case this method will have no effect.
    
    Specified by:
    
    setReadOnly in interface AttributeWriteReadOnly
    
    Specified by:
    
    setReadOnly in interface UiWidget
    
    Parameters:
    
    readOnly - the new value of UiWidget.isReadOnly().
  - setReadOnlyNative
```
protected abstract void setReadOnlyNative(boolean readOnly)
```
    Parameters:
    
    readOnly - the new value of isReadOnly().
  - getReadOnlyFixed
```
public Boolean getReadOnlyFixed()
```
    Specified by:
    
    getReadOnlyFixed in interface UiWidget
    
    Returns:
    
    the fixed read-only mode or null if not fixed.
  - setReadOnlyFixed
```
public void setReadOnlyFixed(Boolean readOnlyFixed)
```
    Description copied from interface: UiWidget
    
    Sets a fixed read-only mode. If not null the read-only mode will be set to that value and further invocations of UiWidget.setReadOnly(boolean) have no effect unless this method is called again with a value of null. Use this method for a widget (e.g. a UiInput) that should always be read-only. Unlike UiWidget.setReadOnly(boolean) this method is not recursive and will not propagate to child widgets.
    
    Specified by:
    
    setReadOnlyFixed in interface UiWidget
    
    Parameters:
    
    readOnlyFixed - the new value of UiWidget.getReadOnlyFixed(). May be null to reset.
  - isValid
```
public boolean isValid()
```
    Description copied from interface: UiWidget
    
    A UiComposite is only valid if all its children are valid (recursive check). An atomic widget that does not implement UiValidatableWidget will always return true here.
    
    Specified by:
    
    isValid in interface AttributeReadValid
    
    Specified by:
    
    isValid in interface AttributeWriteValidationFailure
    
    Specified by:
    
    isValid in interface UiWidget
    
    Returns:
    
    true if valid (no validation failure is present), false otherwise.
    
    See Also:
    
    UiValidatableWidget, UiWidget.validate()
  - validateDown
```
public boolean validateDown(UiValidState state)
```
    Description copied from interface: UiWidget
    
    Performs validation without upwards propagation.
    
    Specified by:
    
    validateDown in interface UiWidget
    
    Parameters:
    
    state - the new UiValidState.
    
    Returns:
    
    the new valid status as result of this validation. In other words true if this widget and all its potential children have been successfully validated, false otherwise. Can differ from UiValidState.isValid() if the subtree of this widget is valid but other widgets have been validated before.
    
    See Also:
    
    UiWidget.validate()
  - getValidationFailure
```
public final String getValidationFailure()
```
    Specified by:
    
    getValidationFailure in interface AttributeWriteValidationFailure
    
    Returns:
    
    the validation error text of this widget itself (not recursive) or null for no error.
  - setValidationFailure
```
public void setValidationFailure(String validationFailure,
                                 boolean valueException)
```
    Specified by:
    
    setValidationFailure in interface AttributeWriteValidationFailure
    
    Parameters:
    
    validationFailure - is the validation failure text. The empty string or null will clear the error and mark the field as valid. Otherwise the field will be invalid.
    
    valueException - - true if invoked from AttributeReadValue.getValue() due to an exception, false otherwise.
  - doSetValidationFailure
```
protected void doSetValidationFailure(String error)
```
    Called from AttributeWriteValidationFailure.setValidationFailure(String) if the failure actually changed. Do not call manually.
    
    Parameters:
    
    error - the new validation failure. Will be null if valid.
  - ensureHandlers
```
protected void ensureHandlers()
```
    Ensures that the event handlers (adapters) are registered.
  - registerHandlers
```
protected void registerHandlers()
```
    Registers the according handlers to the underlying native widget. Never call manually, only via ensureHandlers().
  - getProgrammaticEventType
```
protected UiEventType getProgrammaticEventType()
```
    Returns:
    
    the UiEventType that was previously set as programmatic. ATTENTION: As a side-effect the value is reset to null.
    
    See Also:
    
    UiEvent.isProgrammatic()
  - setProgrammaticEventType
```
protected void setProgrammaticEventType(UiEventType eventType)
```
    Parameters:
    
    eventType - the UiEventType to mark as programmatic. If the next event is of this type, it will be set as programmatic.
  - unwrap
```
protected UiNativeWidget unwrap()
```
    Specified by:
    
    unwrap in class AbstractUiWidget
    
    Returns:
    
    the unwrapped widget.
    
    See Also:
    
    UiCustomWidget.getDelegate()
  - isDisposed
```
public final boolean isDisposed()
```
    Specified by:
    
    isDisposed in interface UiWidget
    
    Returns:
    
    true if this widget has already been disposed and became useless, false otherwise.
  - requireNotDisposed
```
protected void requireNotDisposed()
```
    Ensures that this widget is not disposed.
    
    Throws:
    
    IllegalStateException - otherwise.
  - dispose
```
public final void dispose()
```
    Description copied from interface: UiWidget
    
    This method disposes this widget. It is detached from the UI and resources are deallocated. A disposed widget can not be used or displayed anymore.
    
    Specified by:
    
    dispose in interface UiWidget
  - doDispose
```
protected void doDispose()
```
    Called from dispose()

Class AbstractUiNativeWidget

Field Summary

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

Constructor Summary

Method Summary

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

AbstractUiNativeWidget

Method Detail

addListener

removeListener

hasListeners

getEventAdapter

fireEvent

isInitiallyVisible

getParent

setParent

isVisible

isVisibleWithoutRoot

setVisible

setVisibleNative

doGetVisibleState

doSetVisibleState

doSetVisibleState

isEnabled

setEnabled

setEnabledNative

doGetEnabledState

doSetEnabledState

doSetEnabledState

isReadOnly

setReadOnly

setReadOnlyNative

getReadOnlyFixed

setReadOnlyFixed

isValid

validateDown

getValidationFailure

setValidationFailure

doSetValidationFailure

ensureHandlers

registerHandlers

getProgrammaticEventType

setProgrammaticEventType

unwrap

isDisposed

requireNotDisposed

dispose

doDispose