com.sun.webui.jsf.component
Class ContentPageTitle

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.ContentPageTitle
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class ContentPageTitle
extends javax.faces.component.UIComponentBase
implements javax.faces.component.NamingContainer

The ContentPageTitle component is used to display a page title.


Field Summary
static java.lang.String CONTENT_BOTTOM_SEPARATOR
           
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
ContentPageTitle()
          Default Constructor.
 
Method Summary
 javax.faces.component.UIComponent getBottomPageSeparator()
          Return a component that implements an page separator image.
 java.lang.String getFamily()
          Return the family for this component.
 java.lang.String getHelpText()
          The help text to display just below the page title.
 java.lang.String getStyle()
          CSS style or styles to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getStyleClass()
          CSS style class or classes to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getTitle()
          The text that is displayed as the page title.
 boolean isSeparator()
          Indicates that the page title separator should be displayed, when set to true.
 boolean isVisible()
          Indicates whether the component should be viewable by the user in the rendered HTML page.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
          Restore the state of this component.
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
          Save the state of this component.
 void setHelpText(java.lang.String helpText)
          The help text to display just below the page title.
 void setId(java.lang.String id)
          The component identifier for this component.
 void setRendered(boolean rendered)
          Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page.
 void setSeparator(boolean separator)
          Indicates that the page title separator should be displayed, when set to true.
 void setStyle(java.lang.String style)
          CSS style or styles to be applied to the outermost HTML element when this component is rendered.
 void setStyleClass(java.lang.String styleClass)
          CSS style class or classes to be applied to the outermost HTML element when this component is rendered.
 void setTitle(java.lang.String title)
          The text that is displayed as the page title.
 void setVisible(boolean visible)
          Indicates whether the component should be viewable by the user in the rendered HTML page.
 
Methods inherited from class javax.faces.component.UIComponentBase
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTENT_BOTTOM_SEPARATOR

public static final java.lang.String CONTENT_BOTTOM_SEPARATOR
See Also:
Constant Field Values
Constructor Detail

ContentPageTitle

public ContentPageTitle()
Default Constructor.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Specified by:
getFamily in class javax.faces.component.UIComponent

getBottomPageSeparator

public javax.faces.component.UIComponent getBottomPageSeparator()
Return a component that implements an page separator image. If a facet named pageSeparator is found that component is returned.
If a facet is not found a PageSeparator component instance is returned with the id
getId() + "_pageSeparator".

If a facet is not defined then the returned Icon component is created every time this method is called.

Returns:
- pageSeparator facet or a PageSeparator instance

setId

public void setId(java.lang.String id)
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.

Overrides:
setId in class javax.faces.component.UIComponentBase

setRendered

public void setRendered(boolean rendered)
Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page. If set to false, the rendered HTML page does not include the HTML for the component. If the component is not rendered, it is also not processed on any subsequent form submission.

Overrides:
setRendered in class javax.faces.component.UIComponentBase

getHelpText

public java.lang.String getHelpText()

The help text to display just below the page title.


setHelpText

public void setHelpText(java.lang.String helpText)

The help text to display just below the page title.

See Also:
getHelpText()

isSeparator

public boolean isSeparator()

Indicates that the page title separator should be displayed, when set to true. The separator is a thin line that displays by default when bottom buttons are used. Set this attibute to false if the separator should not be displayed. This attribute also determines whether to display the pageSeparator facet.


setSeparator

public void setSeparator(boolean separator)

Indicates that the page title separator should be displayed, when set to true. The separator is a thin line that displays by default when bottom buttons are used. Set this attibute to false if the separator should not be displayed. This attribute also determines whether to display the pageSeparator facet.

See Also:
isSeparator()

getStyle

public java.lang.String getStyle()

CSS style or styles to be applied to the outermost HTML element when this component is rendered.


setStyle

public void setStyle(java.lang.String style)

CSS style or styles to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class or classes to be applied to the outermost HTML element when this component is rendered.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class or classes to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyleClass()

getTitle

public java.lang.String getTitle()

The text that is displayed as the page title.


setTitle

public void setTitle(java.lang.String title)

The text that is displayed as the page title.

See Also:
getTitle()

isVisible

public boolean isVisible()

Indicates whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.


setVisible

public void setVisible(boolean visible)

Indicates whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

See Also:
isVisible()

restoreState

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

Restore the state of this component.

Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase

saveState

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

Save the state of this component.

Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIComponentBase


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.