net.sf.mmm.client.ui.api.widget.core

Interface UiWidgetCollapsableSection

All Superinterfaces:

AbstractValidatableObject, Accessibility, AttributeReadAriaRole, AttributeReadCollapsed, AttributeReadDisposed, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadId<String>, AttributeReadLabel, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteCollapsed, AttributeWriteDisposed, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteId<String>, AttributeWriteLabel, AttributeWriteMode, AttributeWriteModeFixed, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureCollapse, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiWidget, UiWidgetNative, UiWidgetRegular

All Known Implementing Classes:

AbstractUiWidgetCollapsableSection, UiWidgetCollapsableSectionGwt, UiWidgetCollapsableSectionTestImpl

public interface UiWidgetCollapsableSection
extends UiWidgetRegular, AttributeWriteLabel, UiFeatureCollapse, UiWidgetNative

This is the interface for a regular widget that represents a collapsable section. It is like UiWidgetSection but allows to be collapsed and expanded.
ATTENTION:
This widget should only be used directly for specific situations.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	STYLE_COLLAPSE_BUTTON The style for the button to collapse/expand.
static String	STYLE_COLLAPSED The additional style for the button in case the section is collapsed.
static String	STYLE_PRIMARY The default primary style of this widget.

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadLabel

PROPERTY_LABEL

Fields inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

STYLE_HEADER

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

HTML_ATTRIBUTE_ID, ID_SEPARATOR, PROPERTY_ID

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

Fields inherited from interface net.sf.mmm.util.lang.api.concern.Accessibility

WAI_ARIA

Method Summary

Modifier and Type	Method and Description
void	addCollapseWidget(UiWidget widget) Adds a collapse handler that triggers the AttributeWriteVisibleAdvanced.getVisibleFlag() visibility} of the given UiWidget.

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

setLabel

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

getLabel

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureCollapse

addCollapseHandler, removeCollapseHandle

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

setCollapsed

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

isCollapsed

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

getContext, getParent, getSize

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureMessages

clearMessages

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureEvent

addEventHandler, removeEventHandler

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

setMode

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

getMode

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

setModeFixed

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

getModeFixed

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

setId

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

getId

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

setTooltip

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

getTooltip

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

getVisibleFlag, isVisible, setVisible, setVisible

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

isVisibleRecursive

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

setEnabled

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

isEnabled

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

addStyle, removeStyle

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

hasStyle

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

setStyles

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

getStyles

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

setPrimaryStyle

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

getPrimaryStyle

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteDisposed

dispose

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadDisposed

isDisposed

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

isModified

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

getAriaRole

Methods inherited from interface net.sf.mmm.util.validation.api.AbstractValidatableObject

validate

Field Detail

STYLE_PRIMARY

static final String STYLE_PRIMARY

The default primary style of this widget.

See Also:

Constant Field Values

STYLE_COLLAPSE_BUTTON

static final String STYLE_COLLAPSE_BUTTON

The style for the button to collapse/expand.

See Also:

Constant Field Values

STYLE_COLLAPSED

static final String STYLE_COLLAPSED

The additional style for the button in case the section is collapsed.

See Also:

Constant Field Values

Method Detail

addCollapseWidget

void addCollapseWidget(UiWidget widget)

Adds a collapse handler that triggers the AttributeWriteVisibleAdvanced.getVisibleFlag() visibility} of the given UiWidget. On collapse the UiWidget will be hidden, on expand it will be shown (or more precisely its visible state will be restored).

Parameters:

widget - is the widget to add.