AbstractMutableContainer (wcomponents-core 1.5.24 API)

java.lang.Object
- com.github.bordertech.wcomponents.AbstractWComponent
- - com.github.bordertech.wcomponents.AbstractContainer
  - - com.github.bordertech.wcomponents.AbstractNamingContextContainer
    - - com.github.bordertech.wcomponents.AbstractMutableContainer

All Implemented Interfaces:

Container, MutableContainer, NamingContextable, WComponent, WebComponent, Serializable

Direct Known Subclasses:

AbstractTransientDataContainer, ProfileContainer, WApplication, WCardManager, WColumn, WDecoratedLabel, WFieldSet, WInvisibleContainer, WLabel
```
public abstract class AbstractMutableContainer
extends AbstractNamingContextContainer
implements MutableContainer
```
This abstract class extends AbstractContainer and implements the MutableContainer interface to expose methods for modifying the contents of a container. This class is extended by other container classes which allow arbitrary content.

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 Description

AbstractMutableContainer()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`add(WComponent component)`	Adds the given component as a child of this component.
`void`	`add(WComponent component, String tag)`	Deprecated. Use `WTemplate` instead
`void`	`remove(WComponent aChild)`	Removes the given component from this component.
`void`	`removeAll()`	Removes all the child components from this component.

Methods inherited from class com.github.bordertech.wcomponents.AbstractNamingContextContainer
getNamingContextId, isNamingContext, setNamingContext

Methods inherited from class com.github.bordertech.wcomponents.AbstractContainer
getChildAt, getChildCount, getChildren, getIndexOfChild

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.Container
getChildAt, getChildCount, getChildren, getIndexOfChild

Methods inherited from interface com.github.bordertech.wcomponents.NamingContextable
getNamingContextId, isNamingContext

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
  - AbstractMutableContainer
```
public AbstractMutableContainer()
```
- Method Detail
  - add
```
public void add(WComponent component)
```
    Adds the given component as a child of this component.
    
    Specified by:
    
    add in interface MutableContainer
    
    Parameters:
    
    component - the component to add.
  - add
```
@Deprecated
public void add(WComponent component,
                String tag)
```
    Deprecated.
    Use WTemplate instead
    
    Add the given component as a child of this component. The tag is used to identify the child in this component's velocity template.
    
    Parameters:
    
    component - the component to add.
    
    tag - the tag used to identify the component.
  - remove
```
public void remove(WComponent aChild)
```
    Removes the given component from this component.
    
    Specified by:
    
    remove in interface MutableContainer
    
    Parameters:
    
    aChild - the child component to remove
  - removeAll
```
public void removeAll()
```
    Removes all the child components from this component.
    
    Specified by:
    
    removeAll in interface MutableContainer