Package com.github.bordertech.wcomponents

Class WCollapsibleToggle

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WCollapsibleToggle

All Implemented Interfaces:

AjaxTarget, WComponent, WebComponent, Serializable

public class WCollapsibleToggle
extends AbstractWComponent
implements AjaxTarget

This is component can be used to expand or collapse all collapsibles. It can also belong to a CollapsibleGroup, in this case the toggle functionality will apply to the WCollapsible and WTabSet (if accordion) components in that group only.

Since:

1.0.0

Author:

Ming Gao, Yiannis Paschalidis, Mark Reeves

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WCollapsibleToggle.CollapsibleModel	Holds the extrinsic state information of the component.

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.AbstractWComponent

AbstractWComponent.WComponentRef

Field Summary

Fields inherited from interface com.github.bordertech.wcomponents.WComponent

DEFAULT_APPLICATION_ID, DEFAULT_INTERNAL_ID, DEFAULT_NO_ID, ID_CONTEXT_SEPERATOR, ID_FRAMEWORK_ASSIGNED_SEPERATOR, ID_VALIDATION_PATTERN

Constructor Summary

Constructors

Constructor	Description
WCollapsibleToggle()	Creates a WCollapsibleToggle.
WCollapsibleToggle(boolean clientSide)	Deprecated. 1.2.0 all WCollapsibleToggles are client side.
WCollapsibleToggle(boolean clientSide, CollapsibleGroup group)	Deprecated. 1.2.0 all WCollapsibleToggles are client side use WCollapsibleToggle(com.github.bordertech.wcomponents.CollapsibleGroup).
WCollapsibleToggle(CollapsibleGroup group)	Creates a WCollapsibleToggle for the given CollapsibleGroup.

Method Summary

Modifier and Type	Method	Description
protected WCollapsibleToggle.CollapsibleModel	getComponentModel()	Returns the effective component model for this component.
CollapsibleGroup	getGroup()
String	getGroupName()	Retrieves the name of the CollapsibleGroup associated with this toggle.
protected WCollapsibleToggle.CollapsibleModel	getOrCreateComponentModel()	Retrieves the model for this component so that it can be modified.
boolean	isClientSideToggleable()	Deprecated. 1.2.0 all WCollapsibleToggles are client side
protected WCollapsibleToggle.CollapsibleModel	newComponentModel()	Creates a new Component model.
void	setGroup(CollapsibleGroup group)	Sets the collapsible group that this WCollapsibleToggle can expand/collapse.

Methods inherited from class com.github.bordertech.wcomponents.AbstractWComponent

addHtmlClass, addHtmlClass, addNotify, afterPaint, assertAddSupported, beforePaint, createErrorDiagnostic, createErrorDiagnostic, forward, getAccessibleText, getAttribute, getBaseUrl, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, handleRequest, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, paintComponent, preparePaint, preparePaintComponent, removeAttribute, removeComponentModel, removeHtmlClass, removeHtmlClass, removeNotify, replaceWComponent, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFlag, setFocussed, setHidden, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showErrorIndicatorsForComponent, showWarningIndicators, showWarningIndicatorsForComponent, tidyUpUIContext, tidyUpUIContextForTree, toString, validate, validateComponent, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.bordertech.wcomponents.WComponent

addHtmlClass, addHtmlClass, forward, getAccessibleText, getAttribute, getBaseUrl, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getTabIndex, getTag, getToolTip, handleRequest, hasTabIndex, invokeLater, isDefaultState, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, preparePaint, removeAttribute, removeHtmlClass, removeHtmlClass, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFocussed, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showWarningIndicators, tidyUpUIContextForTree, validate

Constructor Detail

WCollapsibleToggle

public WCollapsibleToggle()

Creates a WCollapsibleToggle.

WCollapsibleToggle

public WCollapsibleToggle(boolean clientSide)

Deprecated.

1.2.0 all WCollapsibleToggles are client side.

Creates a WCollapsibleToggle.

Parameters:

clientSide - if true, the collapse/expand is handled client-side

WCollapsibleToggle

public WCollapsibleToggle(boolean clientSide,
                          CollapsibleGroup group)

Deprecated.

1.2.0 all WCollapsibleToggles are client side use WCollapsibleToggle(com.github.bordertech.wcomponents.CollapsibleGroup).

Creates a WCollapsibleToggle for the given CollapsibleGroup.

Parameters:

clientSide - if true, the collapse/expand is handled client-side.

group - the CollapsibleGroup to create the toggle for.

WCollapsibleToggle

public WCollapsibleToggle(CollapsibleGroup group)

Creates a WCollapsibleToggle for the given CollapsibleGroup.

Parameters:

group - the CollapsibleGroup to create the toggle for.

Method Detail

isClientSideToggleable

public boolean isClientSideToggleable()

Deprecated.

1.2.0 all WCollapsibleToggles are client side

Indicates whether processing will occur client-side.

Returns:

true if processing is handled client-side, or false for server-side.

getGroupName

public String getGroupName()

Retrieves the name of the CollapsibleGroup associated with this toggle. If no group has been associated, this component's name is returned.

Returns:

the group name.

setGroup

public void setGroup(CollapsibleGroup group)

Sets the collapsible group that this WCollapsibleToggle can expand/collapse.

Parameters:

group - the CollapsibleGroup to expand/collapse.

getGroup

public CollapsibleGroup getGroup()

Returns:

the CollapsibleGroup that this WCollapsibleToggle can expand/collapse.

newComponentModel

protected WCollapsibleToggle.CollapsibleModel newComponentModel()

Creates a new Component model.

Overrides:

newComponentModel in class AbstractWComponent

Returns:

a new CollapsibleModel.

getComponentModel

protected WCollapsibleToggle.CollapsibleModel getComponentModel()

Returns the effective component model for this component. Subclass may override this method to narrow the return type to their specific model type.

Overrides:

getComponentModel in class AbstractWComponent

Returns:

the effective component model

getOrCreateComponentModel

protected WCollapsibleToggle.CollapsibleModel getOrCreateComponentModel()

Retrieves the model for this component so that it can be modified. If this method is called during request processing, and a session specific model does not yet exist, then a new model is created. Subclasses may override this method to narrow the return type to their specific model type.

Overrides:

getOrCreateComponentModel in class AbstractWComponent

Returns:

the model for this component