com.ibm.xsp.component
Class UIPassThroughTag

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              com.ibm.xsp.component.UIOutputEx
                  com.ibm.xsp.component.UIPassThroughTag

All Implemented Interfaces:

FacesComponent, FacesOutputFiltering, ThemeControl, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class UIPassThroughTag
extends UIOutputEx

Represents a template tag from the source page, this is used directly within in the compiled XPage .java file, there is no subclass. Not intended to be subclassed.

Nested Class Summary

static class

UIPassThroughTag.TagAttribute TagAttribute class represents on attribute defined on a pass through tag.

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIOutput

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

UIPassThroughTag()
Control that wraps non-xsp tags and passes them straight through to the response writer during the render phase.

Method Summary

void	_cleanTransientData()
void	addAttribute(java.lang.String name, java.lang.String value)
void	addAttribute(java.lang.String name, javax.faces.el.ValueBinding value)
java.lang.String	getClientId(javax.faces.context.FacesContext context) The client id equals to the component id.
java.lang.String	getNamespaceUri()
java.lang.String	getStyleKitFamily() The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source.
java.lang.String	getTag()
java.util.List<UIPassThroughTag.TagAttribute>	getTagAttributes()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setNamespaceUri(java.lang.String namespaceUri)
void	setTag(java.lang.String tag)

Methods inherited from class com.ibm.xsp.component.UIOutputEx

buildContents, getDefaultHtmlFilter, getHtmlFilter, getHtmlFilterName, initAfterContents, initBeforeContents

Methods inherited from class javax.faces.component.UIOutput

getConverter, getFamily, getLocalValue, getValue, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

UIPassThroughTag

public UIPassThroughTag()

Control that wraps non-xsp tags and passes them straight through to the response writer during the render phase.

Method Detail

getClientId

public java.lang.String getClientId(javax.faces.context.FacesContext context)

The client id equals to the component id.

Overrides:

getClientId in class javax.faces.component.UIComponentBase

_cleanTransientData

public void _cleanTransientData()

getStyleKitFamily

public java.lang.String getStyleKitFamily()

Description copied from interface: ThemeControl

The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source. For example, "InputField.EditBox" is used for most Edit Box controls. See Domino/xsp/nsf/themes/webstandard.theme for more examples.

The implementation may return different values depending on the configuration of the current control, for example the Button control returns a different value and looks different when it is configured as a cancel button.

Specified by:

getStyleKitFamily in interface ThemeControl

Overrides:

getStyleKitFamily in class UIOutputEx

Returns:

a non-null themeId corresponding to the configuration for this type of control in a theme file.

getTag

public java.lang.String getTag()

Returns:

returns the tag name for this pass through tag.

setTag

public void setTag(java.lang.String tag)

Parameters:

tag - Sets the tag name for this pass through tag.

getTagAttributes

public java.util.List<UIPassThroughTag.TagAttribute> getTagAttributes()

Returns:

Returns a list of UIPassThroughTag.TagAttribute objects.

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String value)

Parameters:

name - defines the name of the attribute

value - defines the value set on the attribute

addAttribute

public void addAttribute(java.lang.String name,
                         javax.faces.el.ValueBinding value)

getNamespaceUri

public java.lang.String getNamespaceUri()

Returns:

Returns the namespaceUri.

setNamespaceUri

public void setNamespaceUri(java.lang.String namespaceUri)

Parameters:

namespaceUri - The namespaceUri to set.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIOutput

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIOutput