com.ibm.xsp.component
Class UIPanelEx

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              com.ibm.xsp.component.UIDataPanelBase
                  com.ibm.xsp.component.UIPanelEx

All Implemented Interfaces:

FacesAttrsObject, FacesComponent, FacesDataProvider, FacesDojoComponent, ThemeControl, javax.faces.component.StateHolder

Direct Known Subclasses:

UIInclude, UIIncludeComposite, UIViewColumnHeader

public class UIPanelEx
extends UIDataPanelBase
implements ThemeControl, FacesDojoComponent, FacesAttrsObject

XPages Container Controls - Panel.

Container for components. This is the xp:panel tag, and the base superclass for some other tags, some subclasses do not publish all of these fields as properties in the All Properties tab.

Nested Class Summary

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

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Fields inherited from interface com.ibm.xsp.component.FacesDataProvider

DATA, DATA_CONTEXTS

Constructor Summary

UIPanelEx()
Abstract Control used to contain other controls.

Method Summary

void	_xspCleanTransientData()
void	addAttr(Attr attr) Add an Attr, to appear as an attribute in the HTML output of this control or object tag.
void	addDojoAttribute(DojoAttribute attribute) Add a dojo attribute to the set associated with this property.
java.util.List<Attr>	getAttrs() The extra attributes to be output on the base element at the root of this control or object tag.
java.lang.String	getDir()
java.util.List<DojoAttribute>	getDojoAttributes() Return the value of the dojoAttributes property.
java.lang.String	getDojoType() Return the value of the dojoType property.
java.lang.String	getOnClientLoad()
java.lang.String	getOuterStyleClass() Return the value of the outerStyleClass property.
java.lang.String	getRole()
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
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	getTagName() The markup tag that should be generated by the control, instead of the default tag.
java.lang.String	getTitle() Return the value of the title property.
boolean	isDisableOutputTag()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAttrs(java.util.List<Attr> attrs) This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.
void	setDir(java.lang.String dir)
void	setDisableOutputTag(boolean outputTag)
void	setDojoAttributes(java.util.List<DojoAttribute> dojoAttributes) Set the value of the dojoAttributes property.
void	setDojoType(java.lang.String dojoType) Set the value of the dojoType property.
void	setOnClientLoad(java.lang.String onClientLoad)
void	setOuterStyleClass(java.lang.String outerStyleClass) Set the value of the outerStyleClass property.
void	setRole(java.lang.String role)
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setTagName(java.lang.String tagName) Set the value of the tagName property.
void	setTitle(java.lang.String title) Set the value of the title property.

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

addData, addDataContext, afterEncoding, beforeEncoding, broadcast, buildContents, encodeBegin, encodeEnd, getAcl, getData, getDataContexts, hasUserAccess, initAfterContents, initBeforeContents, invokeOnComponent, isAllowCreateViewPublish, isReadonly, isRendered, processDecodes, processUpdates, processValidators, publishControlData, queueEvent, revokeControlData, setAcl, setReadonly, visitTree

Methods inherited from class javax.faces.component.UIPanel

getFamily

Methods inherited from class javax.faces.component.UIComponentBase

_xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

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

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

UIPanelEx

public UIPanelEx()

Abstract Control used to contain other controls.

Method Detail

_xspCleanTransientData

public void _xspCleanTransientData()

Overrides:

_xspCleanTransientData in class UIDataPanelBase

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

Returns:

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

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

CSS style(s) to be applied when this component is rendered.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

getOuterStyleClass

public java.lang.String getOuterStyleClass()

Return the value of the outerStyleClass property. Contents:

Space-separated list of CSS style class(es) to be applied when this control is rendered. When this value is non empty, then the renderer generates an enclosing span using this style as the "class" attribute on generated markup.

setOuterStyleClass

public void setOuterStyleClass(java.lang.String outerStyleClass)

Set the value of the outerStyleClass property.

getDojoType

public java.lang.String getDojoType()

Return the value of the dojoType property. Contents:

Sets the default Dojo Type used to create this control in the browser.

Specified by:

getDojoType in interface FacesDojoComponent

setDojoType

public void setDojoType(java.lang.String dojoType)

Set the value of the dojoType property.

getDojoAttributes

public java.util.List<DojoAttribute> getDojoAttributes()

Return the value of the dojoAttributes property. Contents:

A list of Dojo attributes

Specified by:

getDojoAttributes in interface FacesDojoComponent

addDojoAttribute

public void addDojoAttribute(DojoAttribute attribute)

Add a dojo attribute to the set associated with this property.

Parameters:

action -

setDojoAttributes

public void setDojoAttributes(java.util.List<DojoAttribute> dojoAttributes)

Set the value of the dojoAttributes property.

getAttrs

public java.util.List<Attr> getAttrs()

The extra attributes to be output on the base element at the root of this control or object tag. This should only be used when none of the properties in the All Properties pane correspond to the desired attribute. This may return null. The addAttr(Attr) method should be used to add an Attr.

Specified by:

getAttrs in interface FacesAttrsObject

addAttr

public void addAttr(Attr attr)

Add an Attr, to appear as an attribute in the HTML output of this control or object tag.

Specified by:

addAttr in interface FacesAttrsObject

Parameters:

action -

setAttrs

public void setAttrs(java.util.List<Attr> attrs)

This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIDataPanelBase

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 UIDataPanelBase

setDir

public void setDir(java.lang.String dir)

getDir

public java.lang.String getDir()

setRole

public void setRole(java.lang.String role)

getRole

public java.lang.String getRole()

getOnClientLoad

public java.lang.String getOnClientLoad()

setOnClientLoad

public void setOnClientLoad(java.lang.String onClientLoad)

isDisableOutputTag

public boolean isDisableOutputTag()

setDisableOutputTag

public void setDisableOutputTag(boolean outputTag)

getTagName

public java.lang.String getTagName()

The markup tag that should be generated by the control, instead of the default tag.

setTagName

public void setTagName(java.lang.String tagName)

Set the value of the tagName property.