com.github.bordertech.wcomponents

Class AbstractContainer

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.AbstractContainer

All Implemented Interfaces:

Container, WComponent, WebComponent, Serializable

Direct Known Subclasses:

AbstractNamingContextContainer, WContentLink, WField, WMenuItem, WMenuItemGroup, WTabGroup, WTableColumn

public abstract class AbstractContainer
extends AbstractWComponent
implements Container

This abstract implements the Container interface to expose methods for retrieving the contents of the container. This class is extended by most WComponents which may contain other components.

Since:

1.0.0

Author:

Yiannis Paschalidis

See Also:

Serialized Form

Nested Class Summary

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 and Description
AbstractContainer()

Method Summary

Modifier and Type	Method and Description
WComponent	getChildAt(int index) Retrieves a child component by its index.
int	getChildCount()
List<WComponent>	getChildren() Retrieves the children of this component.
int	getIndexOfChild(WComponent childComponent) Retrieves the index of the given child.

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

addHtmlClass, addHtmlClass, addNotify, afterPaint, assertAddSupported, beforePaint, createErrorDiagnostic, createErrorDiagnostic, forward, getAccessibleText, getAttribute, getBaseUrl, getComponentModel, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getOrCreateComponentModel, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, handleRequest, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, newComponentModel, 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

AbstractContainer

public AbstractContainer()

Method Detail

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface Container

Returns:

the number of child components currently contained within this component.

getChildAt

public WComponent getChildAt(int index)

Retrieves a child component by its index.

Specified by:

getChildAt in interface Container

Parameters:

index - the index of the child component to be retrieved.

Returns:

the child component at the given index.

getIndexOfChild

public int getIndexOfChild(WComponent childComponent)

Retrieves the index of the given child.

Specified by:

getIndexOfChild in interface Container

Parameters:

childComponent - the child component to retrieve the index for.

Returns:

the index of the given child component, or -1 if the component is not a child of this component.

getChildren

public List<WComponent> getChildren()

Description copied from class: AbstractWComponent

Retrieves the children of this component.

Specified by:

getChildren in interface Container

Returns:

a list containing the children of this component, or an empty list.