AbstractTransientDataContainer (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
      - com.github.bordertech.wcomponents.AbstractTransientDataContainer

All Implemented Interfaces:

Container, MutableContainer, NamingContextable, WComponent, WebComponent, Serializable

Direct Known Subclasses:

DefaultTransientDataContainer
```
public abstract class AbstractTransientDataContainer
extends AbstractMutableContainer
```
AbstractTransientContextContainer ensures that all child components have transient state - ie will have their UI contexts reset after each request. The intended usage pattern is to set an attribute in this component's UIContext in the handleRequest(Request) method or from within an action. The attribute can then be used in the setupData() method to read in the data (e.g. from the application cache) and pass it to the children.

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

AbstractTransientDataContainer()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`afterPaint(RenderContext renderContext)`	After the component has been painted, the UIContexts for this component and all its children are cleared.
`void`	`preparePaintComponent(Request request)`	Prepares the component for painting.
`abstract void`	`setupData()`	Subclasses must implement this method to ensure that all child components are set up correctly before they are painted.

Methods inherited from class com.github.bordertech.wcomponents.AbstractMutableContainer
add, add, remove, removeAll

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, 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, 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
  - AbstractTransientDataContainer
```
public AbstractTransientDataContainer()
```
- Method Detail
  - afterPaint
```
protected void afterPaint(RenderContext renderContext)
```
    After the component has been painted, the UIContexts for this component and all its children are cleared.
    
    Overrides:
    
    afterPaint in class AbstractWComponent
    
    Parameters:
    
    renderContext - the renderContext to send output to.
  - preparePaintComponent
```
public final void preparePaintComponent(Request request)
```
    Prepares the component for painting. The setupData() method is called before preparePaint is called for the child components.
    
    Overrides:
    
    preparePaintComponent in class AbstractWComponent
    
    Parameters:
    
    request - the request being responded to.
  - setupData
```
public abstract void setupData()
```
    Subclasses must implement this method to ensure that all child components are set up correctly before they are painted.