NamingContextable (wcomponents-core 1.5.24 API)

All Superinterfaces:

Container, Serializable, WComponent, WebComponent

All Known Subinterfaces:

MutableContainer

All Known Implementing Classes:

AbstractMutableContainer, AbstractNamingContextContainer, AbstractTransientDataContainer, DefaultTransientDataContainer, ProfileContainer, WAjaxPollingRegion, WApplication, WBeanContainer, WCardManager, WCollapsible, WColumn, WColumnLayout, WContainer, WDataRenderer, WDataTable, WDataTableRowRenderer, WDecoratedLabel, WDefinitionList, WFieldLayout, WFieldSet, WFigure, WInvisibleContainer, WLabel, WList, WMenu, WMessages, WNamingContext, WPanel, WRepeater, WRepeater.WRepeatRoot, WRow, WSection, WSubMenu, WTab, WTable, WTable.TableRepeater, WTableRepeater, WTableRowRenderer, WTabSet, WTemplate
```
public interface NamingContextable
extends Container
```
This interface is used to mark components which hold a name context.

Since:

1.0.0

Author:

Jonathan Austin

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
`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.

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

- Method Detail
  - getNamingContextId
```
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.
    
    Returns:
    
    by default, return getId().
  - isNamingContext
```
boolean isNamingContext()
```
    A naming context is only considered active if an Id name has been set.
    
    Returns:
    
    true if active naming context.