org.eclipse.scout.rt.client.ui

Class AbstractWidget

java.lang.Object

org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

org.eclipse.scout.rt.client.ui.AbstractWidget

All Implemented Interfaces:

IStyleable, IWidget, ITypeWithClassId, IPropertyObserver, IEnabledDimension

Direct Known Subclasses:

AbstractAccordion, AbstractAction, AbstractCalendar, AbstractDesktop, AbstractForm, AbstractFormField, AbstractGroup, AbstractLabel, AbstractPlanner, AbstractPopup, AbstractTable, AbstractTile, AbstractTileGrid, AbstractTree, MessageBox, Notification, OutlineMenuWrapper

public abstract class AbstractWidget
extends AbstractPropertyObserver
implements IWidget

Since:

8.0

Field Summary

Fields inherited from class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

propertySupport

Fields inherited from interface org.eclipse.scout.rt.client.ui.IWidget

PROP_DISPOSE_DONE, PROP_ENABLED, PROP_INHERIT_ACCESSIBILITY, PROP_INIT_CONFIG_DONE, PROP_INIT_DONE, PROP_LOADING, PROP_PARENT_WIDGET

Fields inherited from interface org.eclipse.scout.rt.client.ui.IStyleable

PROP_CSS_CLASS

Fields inherited from interface org.eclipse.scout.rt.platform.classid.ITypeWithClassId

ID_CONCAT_SYMBOL

Constructor Summary

Constructors

Constructor and Description
AbstractWidget()
AbstractWidget(boolean callInitializer)

Method Summary

Modifier and Type	Method and Description
void	addWidgetListener(WidgetListener listener)
protected void	callInitializer()
String	classId()
void	dispose() Dispose needs to be called if the widget should not be used anymore in order to release any bound resources.
protected void	disposeChildren()
protected void	disposeChildren(List<? extends IWidget> widgetsToDispose)
protected void	disposeInternal() Will be called by dispose() but only if isDisposeDone() returns false. This method should only dispose this single instance and non-widget children.
protected void	fireWidgetEvent(WidgetEvent event)
List<? extends IWidget>	getChildren()
protected String	getConfiguredCssClass() Configures the css class(es) of this widget.
protected boolean	getConfiguredEnabled() Configures whether this widget is enabled or not.
protected boolean	getConfiguredInheritAccessibility() Configures whether this widgets inherits the enabled state of its parent widgets.
String	getCssClass()
IWidget	getParent()
<T extends IWidget> T	getParentOfType(Class<T> type)
Object	getProperty(String name)
<T extends IWidget> T	getWidgetByClass(Class<T> widgetClassToFind) Tries to find a widget within this widget and all of its children recursively that has exactly the given class (not instanceof).
<T extends IWidget> TreeVisitResult	getWidgetByClassInternal(Holder<T> result, Class<T> widgetClassToFind)
boolean	hasProperty(String name)
void	init() Init is supposed to be called after the widget has been created.
protected void	initChildren()
protected void	initChildren(List<? extends IWidget> widgets)
protected void	initConfig()
protected void	initConfigInternal() Will be called by callInitializer() but only if isInitConfigDone() returns false.
protected void	initInternal() Will be called by init() but only if isInitDone() returns false. This method should initialize this instance and non-widget-children only.
boolean	isDisposeDone()
boolean	isEnabled()
boolean	isEnabled(Predicate<String> filter) Checks all existing enabled dimensions of this widget if their enabled state equals the value returned by the Predicate specified.
boolean	isEnabled(String dimension)
boolean	isEnabledGranted()
boolean	isEnabledIncludingParents()
boolean	isInheritAccessibility()
boolean	isInitConfigDone()
boolean	isInitDone()
boolean	isLoading() Flag to indicate whether this widget is currently loading data.
void	reinit() Re initializes the widget all children by setting IWidget.isInitDone() to false and calling IWidget.init() again.
void	removeWidgetListener(WidgetListener listener)
void	scrollToTop()
void	setCssClass(String cssClass)
protected void	setDisposeDone(boolean disposeDone)
void	setEnabled(boolean enabled) Sets the enabled state for the default dimension.
void	setEnabled(boolean enabled, boolean updateParents) Changes the default enabled dimension of this widget to the given value.
void	setEnabled(boolean enabled, boolean updateParents, boolean updateChildren) Changes the default enabled dimension of this widget to the given value.
void	setEnabled(boolean enabled, boolean updateParents, boolean updateChildren, String dimension) Changes the enabled-state value of the given dimension.
void	setEnabled(boolean enabled, boolean updateParents, String dimension) Changes the enabled-state value of the given dimension.
void	setEnabled(boolean enabled, String dimension)
void	setEnabledGranted(boolean enabled)
void	setEnabledGranted(boolean enabled, boolean updateParents) Changes the granted enabled dimension of this widget to the given value.
void	setEnabledGranted(boolean enabled, boolean updateParents, boolean updateChildren) Changes the granted enabled dimension of this widget to the given value.
void	setEnabledPermission(Permission permission) Uses the Permission provided to calculated the enabled granted state of this widget.
void	setInheritAccessibility(boolean b)
protected void	setInitConfigDone(boolean initConfigDone)
protected void	setInitDone(boolean initDone)
void	setLoading(boolean loading)
boolean	setParentInternal(IWidget w) Sets the parent widget.
void	setProperty(String name, Object value) With this method it's possible to set (custom) properties.
void	visit(Consumer<IWidget> visitor) Visits this IWidget and all of its child IWidgets recursively.
<T extends IWidget> void	visit(Consumer<T> visitor, Class<T> type) Visits this IWidget and all of its child IWidgets recursively.
TreeVisitResult	visit(Function<IWidget,TreeVisitResult> visitor) Visits this IWidget and all of its child IWidgets recursively according to the TreeVisitResult returned by the specified Function.
<T extends IWidget> TreeVisitResult	visit(Function<T,TreeVisitResult> visitor, Class<T> type) Visits this IWidget and all of its child IWidgets recursively according to the TreeVisitResult returned by the specified Function.
TreeVisitResult	visit(IBreadthFirstTreeVisitor<IWidget> visitor) Visits this IWidget and all of its child IWidgets recursively using a level-order strategy.
<T extends IWidget> TreeVisitResult	visit(IBreadthFirstTreeVisitor<T> visitor, Class<T> type) Visits this IWidget and all of its child IWidgets recursively using a level-order strategy.
TreeVisitResult	visit(IDepthFirstTreeVisitor<IWidget> visitor) Visits this IWidget and all of its child IWidgets recursively.
protected TreeVisitResult	visit(IDepthFirstTreeVisitor<IWidget> visitor, Function<IWidget,Collection<? extends IWidget>> childrenSupplier)
<T extends IWidget> TreeVisitResult	visit(IDepthFirstTreeVisitor<T> visitor, Class<T> type) Visits this IWidget and all of its child IWidgets recursively.
protected <T extends IWidget> TreeVisitResult	visit(IDepthFirstTreeVisitor<T> visitor, Function<T,Collection<? extends IWidget>> childrenSupplier, Class<T> type)
boolean	visitParents(Consumer<IWidget> visitor) Visits all parent widgets.
<T extends IWidget> boolean	visitParents(Consumer<T> visitor, Class<T> typeFilter) Visits all parent widgets that are instanceof the given type filter.
boolean	visitParents(Predicate<IWidget> visitor) Visits all parent widgets as long as the Predicate specified returns true.
<T extends IWidget> boolean	visitParents(Predicate<T> visitor, Class<T> typeFilter) Visits all parent widgets that are instanceof the given type filter as long as the Predicate specified returns true.

Methods inherited from class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getSpecificPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.scout.rt.platform.reflect.IPropertyObserver

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.eclipse.scout.rt.client.ui.IStyleable

addCssClass, addCssClasses, removeCssClass, removeCssClasses, toggleCssClass

Constructor Detail

AbstractWidget

public AbstractWidget()

AbstractWidget

public AbstractWidget(boolean callInitializer)

Method Detail

callInitializer

protected final void callInitializer()

initConfigInternal

protected void initConfigInternal()

Will be called by callInitializer() but only if isInitConfigDone() returns false.

initConfig

protected void initConfig()

isInitConfigDone

public boolean isInitConfigDone()

Specified by:

isInitConfigDone in interface IWidget

Returns:

true if #initConfig() has been called, false if not.

setInitConfigDone

protected void setInitConfigDone(boolean initConfigDone)

init

public final void init()

Description copied from interface: IWidget

Init is supposed to be called after the widget has been created. This is usually done by the framework itself. E.g. if the widgets are used on a form, the form will initialize all the widgets on form startup.

After the execution of this method, IWidget.isInitDone() will return true. A repeated execution of IWidget.init() will do nothing unless initDone would be set to false again which is done by IWidget.reinit() and IWidget.dispose(). This means a widget may be initialized again after it has been disposed.

This method initializes this widget and all child widgets recursively.

Specified by:

init in interface IWidget

getWidgetByClass

public <T extends IWidget> T getWidgetByClass(Class<T> widgetClassToFind)

Description copied from interface: IWidget

Tries to find a widget within this widget and all of its children recursively that has exactly the given class (not instanceof).

The first widget in the child hierarchy that has exactly the given class will be returned. The hierarchy is searched in a pre-order traversal.

Specified by:

getWidgetByClass in interface IWidget

Parameters:

widgetClassToFind - The class of the widget. Must not be null.

Returns:

The first widget that is instanceof the given class or null.

getWidgetByClassInternal

public <T extends IWidget> TreeVisitResult getWidgetByClassInternal(Holder<T> result,
                                                                    Class<T> widgetClassToFind)

initChildren

protected void initChildren()

initChildren

protected void initChildren(List<? extends IWidget> widgets)

initInternal

protected void initInternal()

Will be called by init() but only if isInitDone() returns false.
This method should initialize this instance and non-widget-children only. Child widgets will be initialized in initChildren().

isInitDone

public boolean isInitDone()

Specified by:

isInitDone in interface IWidget

Returns:

true if IWidget.init() has been called, false if not. Also returns false if the widget has been disposed.

setInitDone

protected void setInitDone(boolean initDone)

reinit

public void reinit()

Description copied from interface: IWidget

Re initializes the widget all children by setting IWidget.isInitDone() to false and calling IWidget.init() again.

Specified by:

reinit in interface IWidget

dispose

public final void dispose()

Description copied from interface: IWidget

Dispose needs to be called if the widget should not be used anymore in order to release any bound resources. This is usually done by the framework itself. E.g. if the widgets are used on a form, the form will dispose all the widgets when the form closes.

After the execution of this method, IWidget.isDisposeDone() will return true. A repeated execution of IWidget.dispose() will do nothing unless the disposeDone would be set to false which is done by IWidget.init(). This means a widget may be initialized again after it has been disposed.

By calling this method the complete widget tree is disposed recursively.

Specified by:

dispose in interface IWidget

disposeChildren

protected void disposeChildren()

disposeChildren

protected void disposeChildren(List<? extends IWidget> widgetsToDispose)

disposeInternal

protected void disposeInternal()

Will be called by dispose() but only if isDisposeDone() returns false.
This method should only dispose this single instance and non-widget children. Widget children are disposed automatically in disposeChildren().

isDisposeDone

public boolean isDisposeDone()

Specified by:

isDisposeDone in interface IWidget

Returns:

true if IWidget.dispose() has been called, false if not. Also returns false if the widget has been initialized again after it was disposed.

setDisposeDone

protected void setDisposeDone(boolean disposeDone)

visit

public <T extends IWidget> TreeVisitResult visit(Function<T,TreeVisitResult> visitor,
                                                 Class<T> type)

Description copied from interface: IWidget

Visits this IWidget and all of its child IWidgets recursively according to the TreeVisitResult returned by the specified Function.

The visit performs a pre-order traversal. Every IWidget is only visited once. The specified visitor is only called for IWidgets that are of the specified type.

Specified by:

visit in interface IWidget

Type Parameters:

T - The type of widget that should be visited.

Parameters:

visitor - The visitor to call. Must not be null. The IWidget passed to the Function is never null. The Function returns a TreeVisitResult to control the traversal.

type - The type of widget that should be visited.

Returns:

The TreeVisitResult of the last call to the specified Function.

See Also:

TreeVisitResult

visit

public <T extends IWidget> void visit(Consumer<T> visitor,
                                      Class<T> type)

Description copied from interface: IWidget

Visits this IWidget and all of its child IWidgets recursively.

The visit performs a pre-order traversal. Every IWidget is only visited once. The specified visitor is only called for IWidgets that are of the specified type.

Specified by:

visit in interface IWidget

Type Parameters:

T - The type of widget that should be visited.

Parameters:

visitor - The visitor to call. Must not be null. The IWidget passed to the Consumer is never null.

type - The type of widget that should be visited.

visit

public void visit(Consumer<IWidget> visitor)

Description copied from interface: IWidget

Visits this IWidget and all of its child IWidgets recursively.

The visit performs a pre-order traversal. Every IWidget is only visited once.

Specified by:

visit in interface IWidget

Parameters:

visitor - The visitor to call. Must not be null. The IWidget passed to the Consumer is never null.

visit

public TreeVisitResult visit(Function<IWidget,TreeVisitResult> visitor)

Description copied from interface: IWidget

Visits this IWidget and all of its child IWidgets recursively according to the TreeVisitResult returned by the specified Function.

The visit performs a pre-order traversal. Every IWidget is only visited once.

Specified by:

visit in interface IWidget

Parameters:

visitor - The visitor to call. Must not be null. The IWidget passed to the Function is never null. The Function returns a TreeVisitResult to control the traversal.

Returns:

The TreeVisitResult of the last call to the specified Function.

See Also:

TreeVisitResult

visit

public <T extends IWidget> TreeVisitResult visit(IDepthFirstTreeVisitor<T> visitor,
                                                 Class<T> type)

Description copied from interface: IWidget

Visits this IWidget and all of its child IWidgets recursively.

The specified IDepthFirstTreeVisitor controls the visited elements using the TreeVisitResult returned by IDepthFirstTreeVisitor#preVisit(T, int, int). Every IWidget is only visited once. The specified visitor is only called for IWidgets that are of the specified type.

Specified by:

visit in interface IWidget

Type Parameters:

T - The type of widget that should be visited.

Parameters:

visitor - The IDepthFirstTreeVisitor to call. Must not be null.

type - The type of widget that should be visited.

Returns:

The TreeVisitResult of the last call to the specified IDepthFirstTreeVisitor.

See Also:

IDepthFirstTreeVisitor, TreeVisitResult

visit

public TreeVisitResult visit(IDepthFirstTreeVisitor<IWidget> visitor)

Description copied from interface: IWidget

Visits this IWidget and all of its child IWidgets recursively.

The specified IDepthFirstTreeVisitor controls the visited elements using the TreeVisitResult returned by IDepthFirstTreeVisitor#preVisit(T, int, int). Every IWidget is only visited once.

Specified by:

visit in interface IWidget

Parameters:

visitor - The IDepthFirstTreeVisitor to call. Must not be null.

Returns:

The TreeVisitResult of the last call to the specified IDepthFirstTreeVisitor.

See Also:

IDepthFirstTreeVisitor, TreeVisitResult

visit

protected <T extends IWidget> TreeVisitResult visit(IDepthFirstTreeVisitor<T> visitor,
                                                    Function<T,Collection<? extends IWidget>> childrenSupplier,
                                                    Class<T> type)

visit

protected TreeVisitResult visit(IDepthFirstTreeVisitor<IWidget> visitor,
                                Function<IWidget,Collection<? extends IWidget>> childrenSupplier)

visit

public <T extends IWidget> TreeVisitResult visit(IBreadthFirstTreeVisitor<T> visitor,
                                                 Class<T> type)

Description copied from interface: IWidget

Visits this IWidget and all of its child IWidgets recursively using a level-order strategy.

The specified IBreadthFirstTreeVisitor controls the visited elements using the TreeVisitResult returned by IBreadthFirstTreeVisitor#visit(T, int, int). Every IWidget is only visited once. The specified visitor is only called for IWidgets that are of the specified type.

Specified by:

visit in interface IWidget

Type Parameters:

T - The type of widget that should be visited.

Parameters:

visitor - The IBreadthFirstTreeVisitor to use. Must not be null.

type - The type of widget that should be visited.

Returns:

The TreeVisitResult of the last call to the specified IBreadthFirstTreeVisitor.

See Also:

IBreadthFirstTreeVisitor, TreeVisitResult

visit

public TreeVisitResult visit(IBreadthFirstTreeVisitor<IWidget> visitor)

Description copied from interface: IWidget

Visits this IWidget and all of its child IWidgets recursively using a level-order strategy.

The specified IBreadthFirstTreeVisitor controls the visited elements using the TreeVisitResult returned by IBreadthFirstTreeVisitor#visit(T, int, int). Every IWidget is only visited once.

Specified by:

visit in interface IWidget

Parameters:

visitor - The IBreadthFirstTreeVisitor to use. Must not be null.

Returns:

The TreeVisitResult of the last call to the specified IBreadthFirstTreeVisitor.

See Also:

IBreadthFirstTreeVisitor, TreeVisitResult

getChildren

public List<? extends IWidget> getChildren()

Specified by:

getChildren in interface IWidget

Returns:

All child IWidgets. The resulting List is never null and does not contain any null elements.

getConfiguredEnabled

protected boolean getConfiguredEnabled()

Configures whether this widget is enabled or not.

The value returned by this method is used for the default enabled dimension only.

Subclasses can override this method. Default is true.

Returns:

true if this widget is enabled and false otherwise.

See Also:

setEnabled(boolean, String), isEnabledIncludingParents()

getConfiguredInheritAccessibility

protected boolean getConfiguredInheritAccessibility()

Configures whether this widgets inherits the enabled state of its parent widgets.

For example a menu of a table field with isInheritAccessibility()== true is automatically disabled if the table field is disabled.

Subclasses can override this method. Default is true.

Returns:

true if this widget is only enabled if all parent widgets are enabled as well. false if the enabled state of this widget is independent of the parent widgets.

See Also:

setInheritAccessibility(boolean), isEnabledIncludingParents()

getConfiguredCssClass

protected String getConfiguredCssClass()

Configures the css class(es) of this widget.

Subclasses can override this method. Default is null.

Returns:

a string containing one or more classes separated by space, or null if no class should be set.

getCssClass

public String getCssClass()

Specified by:

getCssClass in interface IStyleable

setCssClass

public void setCssClass(String cssClass)

Specified by:

setCssClass in interface IStyleable

getProperty

public Object getProperty(String name)

Specified by:

getProperty in interface IWidget

setProperty

public void setProperty(String name,
                        Object value)

Description copied from interface: IWidget

With this method it's possible to set (custom) properties.

Important: Although this method is intended to be used for custom properties, it's actually possible to change main properties as well. Keep in mind that directly changing main properties may result in unexpected behavior, so do it only if necessary. Rather use the provided API instead.

Specified by:

setProperty in interface IWidget

hasProperty

public boolean hasProperty(String name)

Specified by:

hasProperty in interface IWidget

isLoading

public boolean isLoading()

Description copied from interface: IWidget

Flag to indicate whether this widget is currently loading data. Default is false. The exact interpretation of this flag (and also if it should be respected at all) is left to the UI.

Specified by:

isLoading in interface IWidget

setLoading

public void setLoading(boolean loading)

Specified by:

setLoading in interface IWidget

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface IWidget

Returns:

true if this widget is enabled.

The result of this method does not respect any parent widgets. Use IWidget.isEnabledIncludingParents() whenever necessary.

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: IWidget

Sets the enabled state for the default dimension.

The actual enabled state depends on all dimensions. So the call to this method may not be sufficient to enable a widget (if other dimensions are still disabled).

Specified by:

setEnabled in interface IWidget

Parameters:

enabled - the new enabled state.

isEnabledGranted

public boolean isEnabledGranted()

Specified by:

isEnabledGranted in interface IWidget

Returns:

The value for the enabled granted dimension.

setEnabledGranted

public void setEnabledGranted(boolean enabled)

Specified by:

setEnabledGranted in interface IWidget

Parameters:

enabled - the new value for the enabled granted dimension.

isEnabled

public boolean isEnabled(String dimension)

Specified by:

isEnabled in interface IEnabledDimension

isInheritAccessibility

public boolean isInheritAccessibility()

Specified by:

isInheritAccessibility in interface IWidget

Returns:

true if this widget respects the enabled state of parent widgets. If property is set to false, this widget may be enabled even if parent widgets are disabled.

setInheritAccessibility

public void setInheritAccessibility(boolean b)

Specified by:

setInheritAccessibility in interface IWidget

See Also:

IWidget.isInheritAccessibility()

setEnabledPermission

public void setEnabledPermission(Permission permission)

Description copied from interface: IWidget

Uses the Permission provided to calculated the enabled granted state of this widget.

Specified by:

setEnabledPermission in interface IWidget

setEnabledGranted

public void setEnabledGranted(boolean enabled,
                              boolean updateParents)

Description copied from interface: IWidget

Changes the granted enabled dimension of this widget to the given value.

Specified by:

setEnabledGranted in interface IWidget

Parameters:

enabled - The new enable-granted value.

updateParents - if true the enabled properties of all parent widgets are updated to same value as well. This argument only has an effect if the new enabled state is true.

setEnabledGranted

public void setEnabledGranted(boolean enabled,
                              boolean updateParents,
                              boolean updateChildren)

Description copied from interface: IWidget

Changes the granted enabled dimension of this widget to the given value.

Specified by:

setEnabledGranted in interface IWidget

Parameters:

enabled - The new enable-granted value.

updateParents - if true the enabled properties of all parent widgets are updated to same value as well. This argument only has an effect if the new enabled state is true.

updateChildren - if true the enabled properties of all child widgets (recursive) are updated to same value as well.

setEnabled

public void setEnabled(boolean enabled,
                       boolean updateParents)

Description copied from interface: IWidget

Changes the default enabled dimension of this widget to the given value.

Specified by:

setEnabled in interface IWidget

Parameters:

enabled - The new enabled value.

updateParents - if true the enabled properties of all parent widgets are updated to same value as well. This argument only has an effect if the new enabled state is true.

setEnabled

public void setEnabled(boolean enabled,
                       boolean updateParents,
                       boolean updateChildren)

Description copied from interface: IWidget

Changes the default enabled dimension of this widget to the given value.

Specified by:

setEnabled in interface IWidget

Parameters:

enabled - The new enabled value.

updateParents - if true the enabled properties of all parent widgets are updated to same value as well. This argument only has an effect if the new enabled state is true.

updateChildren - if true the enabled properties of all child widgets (recursive) are updated to same value as well.

setEnabled

public void setEnabled(boolean enabled,
                       String dimension)

Specified by:

setEnabled in interface IEnabledDimension

setEnabled

public void setEnabled(boolean enabled,
                       boolean updateParents,
                       String dimension)

Description copied from interface: IWidget

Changes the enabled-state value of the given dimension.

Specified by:

setEnabled in interface IWidget

Parameters:

enabled - The new enabled-state value for the given dimension.

updateParents - if true the enabled properties of all parent widgets are updated to same value as well. This argument only has an effect if the new enabled state is true.

dimension - The dimension to change. Must not be null.

setEnabled

public void setEnabled(boolean enabled,
                       boolean updateParents,
                       boolean updateChildren,
                       String dimension)

Description copied from interface: IWidget

Changes the enabled-state value of the given dimension.

Specified by:

setEnabled in interface IWidget

Parameters:

enabled - The new enabled-state value for the given dimension.

updateParents - if true the enabled properties of all parent widgets are updated to same value as well. This argument only has an effect if the new enabled state is true.

updateChildren - if true the enabled properties of all child widgets (recursive) are updated to same value as well.

dimension - The dimension to change. Must not be null.

isEnabled

public boolean isEnabled(Predicate<String> filter)

Description copied from interface: IWidget

Checks all existing enabled dimensions of this widget if their enabled state equals the value returned by the Predicate specified.

Specified by:

isEnabled in interface IWidget

Parameters:

filter - A Predicate that is called for each enabled dimension. The corresponding enabled-bit of this widget must be equal to the result of the Predicate. In case null is passed all bits are compared against true (which is the same as IWidget.isEnabled()).

Returns:

true if all enabled dimensions bits have the same value as returned by the specified Predicate.

getParent

public IWidget getParent()

Specified by:

getParent in interface IWidget

Returns:

the parent widget or null if this widget has no parent.

See Also:

IWidget.getParentOfType(Class), IWidget.visitParents(Predicate)

setParentInternal

public boolean setParentInternal(IWidget w)

Description copied from interface: IWidget

Sets the parent widget.

Do not use this internal method.

Specified by:

setParentInternal in interface IWidget

isEnabledIncludingParents

public boolean isEnabledIncludingParents()

Specified by:

isEnabledIncludingParents in interface IWidget

Returns:

true if this widget is enabled for all dimensions and all parent widgets are enabled for all dimensions as well. The parent widgets are only considered as long as IWidget.isInheritAccessibility() is true.

visitParents

public boolean visitParents(Consumer<IWidget> visitor)

Description copied from interface: IWidget

Visits all parent widgets. The receiver itself is not visited

Specified by:

visitParents in interface IWidget

Parameters:

visitor - The visitor to call. Must not be null.

visitParents

public <T extends IWidget> boolean visitParents(Consumer<T> visitor,
                                                Class<T> typeFilter)

Description copied from interface: IWidget

Visits all parent widgets that are instanceof the given type filter. The receiver itself is not visited.

Specified by:

visitParents in interface IWidget

Parameters:

visitor - The visitor to call. Must not be null.

visitParents

public boolean visitParents(Predicate<IWidget> visitor)

Description copied from interface: IWidget

Visits all parent widgets as long as the Predicate specified returns true.

Specified by:

visitParents in interface IWidget

Parameters:

visitor - The visitor to call. Must not be null. The visit aborts when the Predicate returns false.

visitParents

public <T extends IWidget> boolean visitParents(Predicate<T> visitor,
                                                Class<T> typeFilter)

Description copied from interface: IWidget

Visits all parent widgets that are instanceof the given type filter as long as the Predicate specified returns true.

Specified by:

visitParents in interface IWidget

Parameters:

visitor - The visitor to call. Must not be null. The visit aborts when the Predicate returns false.

getParentOfType

public <T extends IWidget> T getParentOfType(Class<T> type)

Specified by:

getParentOfType in interface IWidget

Returns:

The first parent widget that is instanceof the given type or null if no such parent can be found.

classId

public String classId()

Specified by:

classId in interface ITypeWithClassId

scrollToTop

public void scrollToTop()

Specified by:

scrollToTop in interface IWidget

fireWidgetEvent

protected void fireWidgetEvent(WidgetEvent event)

addWidgetListener

public void addWidgetListener(WidgetListener listener)

Specified by:

addWidgetListener in interface IWidget

removeWidgetListener

public void removeWidgetListener(WidgetListener listener)

Specified by:

removeWidgetListener in interface IWidget