com.ibm.xsp.component.xp
Class XspViewTitle

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              com.ibm.xsp.component.UIOutputEx
                  com.ibm.xsp.component.UIViewTitle
                      com.ibm.xsp.component.xp.XspViewTitle

All Implemented Interfaces:

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

public class XspViewTitle
extends UIViewTitle

A control that provides a title for a view

XPages Container Controls - View Title

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

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

XspViewTitle()

Method Summary

java.lang.String	getContentType() Return the value of the contentType property.
java.lang.String	getHtmlFilter() Return the value of the htmlFilter property.
java.lang.String	getOuterStyleClass() Return the value of the outerStyleClass property.
java.lang.String	getPanelPosition() Return the value of the panelPosition property.
java.lang.String	getRole() Return the value of the role property.
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	getTitle() Return the value of the title property.
boolean	isEscape() Return the value of the escape property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
void	setContentType(java.lang.String contentType) Set the value of the contentType property.
void	setEscape(boolean escape) Set the value of the escape property.
void	setHtmlFilter(java.lang.String htmlFilter) Set the value of the htmlFilter property.
void	setOuterStyleClass(java.lang.String outerStyleClass) Set the value of the outerStyleClass property.
void	setPanelPosition(java.lang.String panelPosition) Set the value of the panelPosition property.
void	setRole(java.lang.String role) Set the value of the role property.
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	setTitle(java.lang.String title) Set the value of the title property.

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

addAttr, getAttrs, getStyleKitFamily, setAttrs

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

buildContents, getDefaultHtmlFilter, 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, getClientId, 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

XspViewTitle

public XspViewTitle()

Method Detail

getContentType

public java.lang.String getContentType()

Return the value of the contentType property. Contents:

Specifies the type of content to expect. HTML and Text are supported. Text is the default.

getHtmlFilter

public java.lang.String getHtmlFilter()

Return the value of the htmlFilter property. Contents:

Indicates which Active Content Filtering processor to use.

Overrides:

getHtmlFilter in class UIOutputEx

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 set, the renderer generates an enclosing span using this style as the "class" attribute on generated markup.

getPanelPosition

public java.lang.String getPanelPosition()

Return the value of the panelPosition property. Contents:

Defines a property can be one of four valid values (top | bottom | left | right). Indication where in the cell above the table data that the title is to appear, if omitted, the title will not appear.

getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

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

XPages Styling Category - style

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

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

getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.

isEscape

public boolean isEscape()

Return the value of the escape property. Contents:

Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. This flag is set to "true" by default.

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 UIViewTitle

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIViewTitle

setContentType

public void setContentType(java.lang.String contentType)

Set the value of the contentType property.

setEscape

public void setEscape(boolean escape)

Set the value of the escape property.

setHtmlFilter

public void setHtmlFilter(java.lang.String htmlFilter)

Set the value of the htmlFilter property.

setOuterStyleClass

public void setOuterStyleClass(java.lang.String outerStyleClass)

Set the value of the outerStyleClass property.

setPanelPosition

public void setPanelPosition(java.lang.String panelPosition)

Set the value of the panelPosition property.

setRole

public void setRole(java.lang.String role)

Set the value of the role property.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.