Container (wcomponents-core 1.5.24 API)

All Superinterfaces:

Serializable, WComponent, WebComponent

All Known Subinterfaces:

MutableContainer, NamingContextable

All Known Implementing Classes:

AbstractContainer, AbstractMutableContainer, AbstractNamingContextContainer, AbstractTransientDataContainer, DefaultTransientDataContainer, ProfileContainer, UicProfileButton, WAjaxPollingRegion, WApplication, WBeanContainer, WButton, WCancelButton, WCardManager, WCollapsible, WColumn, WColumnLayout, WConfirmationButton, WContainer, WContentLink, WDataRenderer, WDataTable, WDataTableRowRenderer, WDecoratedLabel, WDefinitionList, WDialog, WField, WFieldLayout, WFieldSet, WFigure, WHeading, WInvisibleContainer, WLabel, WLink, WList, WMenu, WMenuItem, WMenuItemGroup, WMessages, WNamingContext, WPanel, WPrintButton, WRepeater, WRepeater.WRepeatRoot, WRow, WSection, WSubMenu, WTab, WTabGroup, WTable, WTable.TableRepeater, WTableColumn, WTableRepeater, WTableRowRenderer, WTabSet, WTemplate, WWindow
```
public interface Container
extends WComponent
```
The interface for WComponents which can contain child WComponents.

A basic Container is often used to group related components together. Grouping components together is good for readability of the code and it is also how you create reusable chunks of UI.

Since:

1.0.0

Author:

Yiannis Paschalidis

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`WComponent`	`getChildAt(int index)`	Retrieves a child component by its index.
`int`	`getChildCount()`
`List<WComponent>`	`getChildren()`	Retrieves a list of this Container's.
`int`	`getIndexOfChild(WComponent childComponent)`	Retrieves the index of the given child.

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

- Method Detail
  - getChildCount
```
int getChildCount()
```
    Returns:
    
    the number of child components currently contained within this component.
  - getChildAt
```
WComponent getChildAt(int index)
```
    Retrieves a child component by its index.
    
    Parameters:
    
    index - the index of the child component to be retrieved.
    
    Returns:
    
    the child component at the given index.
  - getIndexOfChild
```
int getIndexOfChild(WComponent childComponent)
```
    Retrieves the index of the given child.
    
    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
```
List<WComponent> getChildren()
```
    Retrieves a list of this Container's.
    
    Returns:
    
    an immutable list of this Container.