net.sf.mmm.client.ui.api.attribute

Interface AttributeWriteVisibleAdvanced

All Superinterfaces:

AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteVisible

All Known Subinterfaces:

UiWidget, UiWidgetAbstractBorderPanel, UiWidgetAbstractButton, UiWidgetAbstractButtonContainer, UiWidgetAbstractComposite, UiWidgetAbstractDataSet<ITEM>, UiWidgetAbstractDataTable<ROW>, UiWidgetAbstractDialogWindow, UiWidgetAbstractListTable<ROW>, UiWidgetAbstractTree<NODE>, UiWidgetAbstractTree.UiWidgetTreeNode<NODE>, UiWidgetAbstractWindow, UiWidgetAbstractWithValue<VALUE>, UiWidgetActive, UiWidgetBorderPanel, UiWidgetButton, UiWidgetButtonGroup, UiWidgetButtonPanel, UiWidgetButtonSeparator, UiWidgetCheckboxesField<VALUE>, UiWidgetCheckboxField, UiWidgetClickable, UiWidgetCodeAreaField, UiWidgetCollapsableBorderPanel, UiWidgetCollapsableSection, UiWidgetColorField, UiWidgetComboboxField<VALUE>, UiWidgetComposite<CHILD>, UiWidgetDateField, UiWidgetDoubleField, UiWidgetDynamicComposite<CHILD>, UiWidgetDynamicPanel<CHILD>, UiWidgetField<VALUE>, UiWidgetFileField, UiWidgetGridCell, UiWidgetGridPanel, UiWidgetGridRow, UiWidgetHorizontalPanel, UiWidgetHorizontalSplitPanel, UiWidgetImage, UiWidgetInstantField, UiWidgetIntegerField, UiWidgetIntegerSliderField, UiWidgetLabel, UiWidgetLink, UiWidgetListBase<ROW>, UiWidgetListBoxField<VALUE>, UiWidgetListContainer<ITEM>, UiWidgetListTable<ROW>, UiWidgetLocalDateField, UiWidgetLocalTimeField, UiWidgetLongField, UiWidgetMainWindow, UiWidgetMedia, UiWidgetMediaAudio, UiWidgetMediaPlayer, UiWidgetMediaVideo, UiWidgetMenu, UiWidgetMenuBar, UiWidgetMenuItem, UiWidgetMenuItemCheckbox, UiWidgetMenuItemClickable, UiWidgetMenuItemRadioButton, UiWidgetMenuItemSeparator, UiWidgetMultiComposite<CHILD>, UiWidgetNative, UiWidgetOptionListTable<ROW>, UiWidgetOptionsBase<VALUE>, UiWidgetOptionsField<VALUE>, UiWidgetPanel<CHILD>, UiWidgetPasswordField, UiWidgetPopup, UiWidgetRadioButtonsField<VALUE>, UiWidgetRadioButtonsVerticalField<VALUE>, UiWidgetRangeField<VALUE>, UiWidgetRegular, UiWidgetRegularComposite<CHILD>, UiWidgetRichTextField, UiWidgetSection, UiWidgetSingleComposite<CHILD>, UiWidgetSingleMutableComposite<CHILD>, UiWidgetSlot, UiWidgetSplitPanel, UiWidgetSwitchComposite<CHILD>, UiWidgetSwitchPanel, UiWidgetTab, UiWidgetTableColumn<ROW,CELL>, UiWidgetTabPanel, UiWidgetTextAreaField, UiWidgetTextField, UiWidgetTextualInputField<VALUE>, UiWidgetToggleButton, UiWidgetToolbar, UiWidgetTree<NODE>, UiWidgetTreeTable<NODE>, UiWidgetVerticalPanel, UiWidgetVerticalSplitPanel, UiWidgetWindow, UiWidgetWithSelectedValue<VALUE>, UiWidgetWithValue<VALUE>

All Known Implementing Classes:

AbstractUiWidget, AbstractUiWidgetAbstractBorderPanel, AbstractUiWidgetAbstractButton, AbstractUiWidgetAbstractButtonContainer, AbstractUiWidgetAbstractDataSet, AbstractUiWidgetAbstractDataTable, AbstractUiWidgetAbstractDialogWindow, AbstractUiWidgetAbstractListTable, AbstractUiWidgetAbstractWindow, AbstractUiWidgetActive, AbstractUiWidgetBorderPanel, AbstractUiWidgetButton, AbstractUiWidgetButtonGroup, AbstractUiWidgetButtonPanel, AbstractUiWidgetCheckboxField, AbstractUiWidgetClickable, AbstractUiWidgetCodeAreaField, AbstractUiWidgetCollapsableBorderPanel, AbstractUiWidgetCollapsableSection, AbstractUiWidgetColorField, AbstractUiWidgetComboboxField, AbstractUiWidgetComposite, AbstractUiWidgetCustomMasterDetail, AbstractUiWidgetCustomTwoListSelection, AbstractUiWidgetDateField, AbstractUiWidgetDoubleField, AbstractUiWidgetDynamicComposite, AbstractUiWidgetDynamicPanel, AbstractUiWidgetField, AbstractUiWidgetFileField, AbstractUiWidgetGridCell, AbstractUiWidgetGridPanel, AbstractUiWidgetGridRow, AbstractUiWidgetHorizontalPanel, AbstractUiWidgetHorizontalSplitPanel, AbstractUiWidgetImage, AbstractUiWidgetInstantField, AbstractUiWidgetIntegerField, AbstractUiWidgetIntegerSliderField, AbstractUiWidgetLabel, AbstractUiWidgetLink, AbstractUiWidgetListBoxField, AbstractUiWidgetListTable, AbstractUiWidgetLocalDateField, AbstractUiWidgetLocalTimeField, AbstractUiWidgetLongField, AbstractUiWidgetMainWindow, AbstractUiWidgetMenu, AbstractUiWidgetMenuBar, AbstractUiWidgetMenuItemClickable, AbstractUiWidgetMenuItemSeparator, AbstractUiWidgetNative, AbstractUiWidgetNumberField, AbstractUiWidgetOptionsField, AbstractUiWidgetPasswordField, AbstractUiWidgetPopup, AbstractUiWidgetRadioButtonsField, AbstractUiWidgetRadioButtonsVerticalField, AbstractUiWidgetRangeField, AbstractUiWidgetRegularAtomic, AbstractUiWidgetRichTextField, AbstractUiWidgetSection, AbstractUiWidgetSingleComposite, AbstractUiWidgetSingleMutableComposite, AbstractUiWidgetSlot, AbstractUiWidgetSplitPanel, AbstractUiWidgetSwitchComposite, AbstractUiWidgetTab, AbstractUiWidgetTableColumn, AbstractUiWidgetTabPanel, AbstractUiWidgetTextAreaField, AbstractUiWidgetTextAreaFieldBase, AbstractUiWidgetTextField, AbstractUiWidgetTextFieldBase, AbstractUiWidgetTextualInputField, AbstractUiWidgetToggleButton, AbstractUiWidgetToolbar, AbstractUiWidgetTree, AbstractUiWidgetVerticalPanel, AbstractUiWidgetVerticalSplitPanel, AbstractUiWidgetWindow, AbstractUiWidgetWithLabel, UiWidgetAdapterGwtTree.TreeNodeAdapter, UiWidgetBorderPanelGwt, UiWidgetBorderPanelTestImpl, UiWidgetButtonGroupGwt, UiWidgetButtonGwt, UiWidgetButtonPanelGwt, UiWidgetButtonTestImpl, UiWidgetCheckboxFieldGwt, UiWidgetCheckboxFieldTestImpl, UiWidgetCodeAreaFieldTestImpl, UiWidgetCollapsableBorderPanelGwt, UiWidgetCollapsableSectionGwt, UiWidgetCollapsableSectionTestImpl, UiWidgetColorFieldGwt, UiWidgetColorFieldTestImpl, UiWidgetComboboxFieldGwt, UiWidgetComboboxFieldTestImpl, UiWidgetCustom, UiWidgetCustomAbstractDialogWindow, UiWidgetCustomAbstractListTable, UiWidgetCustomAbstractWindow, UiWidgetCustomAtomicNoValue, UiWidgetCustomButton, UiWidgetCustomButtonSave, UiWidgetCustomComposite, UiWidgetCustomCompositeNoValue, UiWidgetCustomDynamicComposite, UiWidgetCustomEditor, UiWidgetCustomField, UiWidgetCustomFieldAtomic, UiWidgetCustomFieldComposite, UiWidgetCustomFormEditor, UiWidgetCustomGridPanel, UiWidgetCustomListTable, UiWidgetCustomMasterDetail, UiWidgetCustomPanel, UiWidgetCustomPopup, UiWidgetCustomVerticalPanel, UiWidgetDateFieldGwt, UiWidgetDateFieldTestImpl, UiWidgetDoubleFieldGwt, UiWidgetDoubleFieldTestImpl, UiWidgetFileFieldGwt, UiWidgetFileFieldTestImpl, UiWidgetGridCellGwt, UiWidgetGridCellTestImpl, UiWidgetGridPanelGwt, UiWidgetGridPanelTestImpl, UiWidgetGridRowGwt, UiWidgetGridRowTestImpl, UiWidgetHorizontalPanelGwt, UiWidgetHorizontalPanelTestImpl, UiWidgetHorizontalSplitPanelGwt, UiWidgetImageGwt, UiWidgetImageTestImpl, UiWidgetIntegerFieldGwt, UiWidgetIntegerFieldTestImpl, UiWidgetIntegerSliderFieldGwt, UiWidgetIntegerSliderFieldTestImpl, UiWidgetLabelGwt, UiWidgetLabelTestImpl, UiWidgetLinkGwt, UiWidgetLinkTestImpl, UiWidgetListTableGwt, UiWidgetLocalDateFieldGwt, UiWidgetLocalDateFieldTestImpl, UiWidgetLocalTimeFieldGwt, UiWidgetLocalTimeFieldTestImpl, UiWidgetLongFieldGwt, UiWidgetLongFieldTestImpl, UiWidgetMainWindowGwt, UiWidgetMainWindowTestImpl, UiWidgetMenuBarGwt, UiWidgetMenuBarTestImpl, UiWidgetMenuGwt, UiWidgetMenuItemClickableGwt, UiWidgetMenuItemClickableTestImpl, UiWidgetMenuItemSeparatorGwt, UiWidgetMenuItemSeparatorTestImpl, UiWidgetMenuTestImpl, UiWidgetPasswordFieldGwt, UiWidgetPasswordFieldTestImpl, UiWidgetPopupGwt, UiWidgetPopupTestImpl, UiWidgetRadioButtonsFieldGwt, UiWidgetRadioButtonsTestImpl, UiWidgetRadioButtonsVerticalFieldGwt, UiWidgetRadioButtonsVerticalFieldTestImpl, UiWidgetRichTextFieldGwt, UiWidgetRichTextFieldTestImpl, UiWidgetSectionGwt, UiWidgetSectionTestImpl, UiWidgetSlotGwt, UiWidgetSlotTestImpl, UiWidgetTabGwt, UiWidgetTableColumnImpl, UiWidgetTabPanelGwt, UiWidgetTabPanelTestImpl, UiWidgetTabTestImpl, UiWidgetTextAreaFieldGwt, UiWidgetTextAreaFieldTestImpl, UiWidgetTextFieldGwt, UiWidgetTextFieldTestImpl, UiWidgetToggleButtonGwt, UiWidgetToolbarGwt, UiWidgetTreeGwt, UiWidgetTreeTestImpl, UiWidgetVerticalPanelGwt, UiWidgetVerticalPanelTestImpl, UiWidgetVerticalSplitPanelGwt, UiWidgetWindowGwt

public interface AttributeWriteVisibleAdvanced
extends AttributeWriteVisible, AttributeReadVisibleRecursive

This interface gives advanced read and write access to the visibility of an object.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

setVisible(boolean)

Method Summary

Modifier and Type	Method and Description
AttributeWriteFlagAdvanced	getVisibleFlag() This method gets advanced visibility support.
boolean	isVisible() This method determines if this object is set to visible.
void	setVisible(boolean visible) This method shows or hides this object.
void	setVisible(boolean visible, boolean programmatic) This method shows or hides this object.

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadVisibleRecursive

isVisibleRecursive

Method Detail

getVisibleFlag

AttributeWriteFlagAdvanced getVisibleFlag()

This method gets advanced visibility support. It allows you to read and write the visibility for different cross-cutting concerns.
Motivation:
Typical UI toolkits provide visibility as a primitive boolean attribute or property. However, this is leading to various problems if you have multiple aspects that influence the flag. E.g. assume you have some dynamic effect that is showing or hiding a widget. Additionally the widget is in a collapsable section, tab-panel, or the like that is also showing or hiding the widget. Further, there might be an authorization in your application as a cross-cutting concern that hides widgets from the UI according to the current roles and permissions of the user. If this is all based on a simple boolean flag you will end up in a mess and with a buggy application. So the dynamic effect or even worse the authorization will hide the widget but after the user collapses and then expands a panel it becomes visible again. You do not want to deal with bugs like this.
ATTENTION:
The returned instance may be lazily created. It will not be expensive but for a large UI this will sum up. In a web or especially a mobile client memory might be low. So if you are recursively traversing the UI widget tree you should only rely on isVisible() for reading visibility.

Returns:

the mutable flag for advanced visibility support.

isVisible

boolean isVisible()

This method determines if this object is set to visible.
ATTENTION:
This method is an efficient shortcut for getVisibleFlag().getFlag(). If you want to read the value that has been set via setVisible(boolean) you would need to do getVisibleFlag().getFlag(null) instead. See getVisibleFlag() for more information.

Specified by:

isVisible in interface AttributeReadVisible

Returns:

true if programmatically set visible, false if directly programmatically hidden.

See Also:

AttributeReadVisibleRecursive.isVisibleRecursive()

setVisible

void setVisible(boolean visible)

This method shows or hides this object.
ATTENTION:
This method is NOT symmetric to isVisible(). It is an efficient shortcut for getVisibleFlag().setFlag(visible, null).

Specified by:

setVisible in interface AttributeWriteVisible

Parameters:

visible - is the new visibility status of this object. If true, the object will be shown (and raised), if false the object will be hidden (iconified).

See Also:

isVisible()

setVisible

void setVisible(boolean visible,
                boolean programmatic)

This method shows or hides this object.

Parameters:

visible - is the new visibility status of this object. If true, the object will be shown (and raised), if false the object will be hidden (iconified).

programmatic - - see UiEvent.isProgrammatic().

See Also:

isVisible()