Package com.github.bordertech.wcomponents

Class WComponentGroup<T extends WComponent>

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WComponentGroup<T>

Type Parameters:

T - the type of component which the group contains.

All Implemented Interfaces:

SubordinateTarget, WComponent, WebComponent, Serializable

public class WComponentGroup<T extends WComponent>
extends AbstractWComponent
implements SubordinateTarget

Define a group of components that can be used or controlled by other components like WSubordinateControl.

Since:

1.0.0

Author:

Jonathan Austin

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WComponentGroup.ComponentGroupModel	A class used to hold the list of components.

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
WComponentGroup()

Method Summary

Modifier and Type	Method	Description
void	addToGroup(T component)	Add a component to this group.
protected WComponentGroup.ComponentGroupModel	getComponentModel()	Returns the effective component model for this component.
List<T>	getComponents()
protected WComponentGroup.ComponentGroupModel	getOrCreateComponentModel()	Retrieves the model for this component so that it can be modified.
protected WComponentGroup.ComponentGroupModel	newComponentModel()	Creates a new model appropriate for the type of component.
void	removeFromGroup(T component)	Remove a component from this group.
String	toString()	Creates a String representation of this component; usually for debugging purposes.

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

WComponentGroup

public WComponentGroup()

Method Detail

addToGroup

public void addToGroup(T component)

Add a component to this group.

Parameters:

component - the component to add.

removeFromGroup

public void removeFromGroup(T component)

Remove a component from this group.

Parameters:

component - the component to add.

getComponents

public List<T> getComponents()

Returns:

the list of WComponents in this group.

toString

public String toString()

Description copied from class: AbstractWComponent

Creates a String representation of this component; usually for debugging purposes.

Overrides:

toString in class AbstractWComponent

Returns:

a String representation of this component, for debugging purposes.

newComponentModel

protected WComponentGroup.ComponentGroupModel newComponentModel()

Creates a new model appropriate for the type of component. Subclasses can override, and should narrow the return type.

Overrides:

newComponentModel in class AbstractWComponent

Returns:

a new ComponentModel.

getComponentModel

protected WComponentGroup.ComponentGroupModel 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 WComponentGroup.ComponentGroupModel 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