AbstractNamingContextContainer (wcomponents-core 1.5.24 API)

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

All Implemented Interfaces:

Container, NamingContextable, WComponent, WebComponent, Serializable

Direct Known Subclasses:

AbstractMutableContainer, WCollapsible, WColumnLayout, WDefinitionList, WFieldLayout, WFigure, WMenu, WRow, WSection, WSubMenu, WTab, WTabSet
```
public abstract class AbstractNamingContextContainer
extends AbstractContainer
implements NamingContextable
```
This abstract container implements NamingContextable.

Since:

1.0.0

Author:

Jonathan Austin

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

AbstractNamingContextContainer()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getNamingContextId()`	Allow components that implement `NamingContextable` to selectively disable prepending their ID to their descendent's IDs by breaking the prepending logic into a seperately callable method.
`boolean`	`isNamingContext()`	A naming context is only considered active if an Id name has been set.
`void`	`setNamingContext(boolean context)`	A naming context is only considered active if it has been set active via `setNamingContext(boolean)` and also has an id name set via `AbstractWComponent.setIdName(String)`.

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.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
  - AbstractNamingContextContainer
```
public AbstractNamingContextContainer()
```
- Method Detail
  - setNamingContext
```
public void setNamingContext(boolean context)
```
    A naming context is only considered active if it has been set active via setNamingContext(boolean) and also has an id name set via AbstractWComponent.setIdName(String).
    
    Parameters:
    
    context - set true if this is a naming context.
  - isNamingContext
```
public boolean isNamingContext()
```
    A naming context is only considered active if an Id name has been set.
    
    Specified by:
    
    isNamingContext in interface NamingContextable
    
    Returns:
    
    true if active naming context.
  - getNamingContextId
```
public String getNamingContextId()
```
    Allow components that implement NamingContextable to selectively disable prepending their ID to their descendent's IDs by breaking the prepending logic into a seperately callable method.
    See WComponent.getId() for usage.
    
    By default, this method will call through to WComponent.getId() and return the result.
    
    Specified by:
    
    getNamingContextId in interface NamingContextable
    
    Returns:
    
    by default, return getId().