org.apache.myfaces.tobago.component
Class UIPage

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIForm
              org.apache.myfaces.tobago.internal.component.AbstractUIForm
                  org.apache.myfaces.tobago.internal.component.AbstractUIPage
                      org.apache.myfaces.tobago.component.UIPage

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, InvokeOnComponent, DeprecatedDimension, Form, OnComponentPopulated, SupportsMarkup, Configurable, LayoutBase, LayoutBox, LayoutContainer

public class UIPage
extends AbstractUIPage
implements SupportsMarkup

Renders a page element. UIComponent class, generated from template component1.2.stg with class PageTagDeclaration.

Field Summary

static String

COMPONENT_TYPE

Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIPage

FORM_ACCEPT_CHARSET

Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIForm

SUBMITTED_MARKER

Fields inherited from class javax.faces.component.UIForm

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface org.apache.myfaces.tobago.component.OnComponentPopulated

MARKER

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIPage()

Method Summary

String	getApplicationIcon() Absolute URL to an image or image name to lookup in tobago resource path representing the application.
Measure	getBorderBottom() This attribute is for internal use only.
Measure	getBorderLeft() This attribute is for internal use only.
Measure	getBorderRight() This attribute is for internal use only.
Measure	getBorderTop() This attribute is for internal use only.
Integer	getColumnSpan()
Measure	getCurrentHeight() This value will usually be set by the layout manager.
Markup	getCurrentMarkup()
Measure	getCurrentWidth() This value will usually be set by the layout manager.
Display	getDisplay() This attribute is for internal use only.
String	getFocusId() Contains the id of the component which should have the focus after loading the page.
Measure	getHeight() The height of the component in the UI.
Integer	getHorizontalIndex() This attribute is for internal use only.
String	getLabel() Text value to display as label.
Measure	getLeft() This value will usually be set by the layout manager.
Measure	getMarginBottom()
Measure	getMarginLeft()
Measure	getMarginRight()
Measure	getMarginTop()
Markup	getMarkup()
Measure	getMaximumHeight()
Measure	getMaximumWidth()
Measure	getMinimumHeight()
Measure	getMinimumWidth()
Measure	getPaddingBottom() This attribute is for internal use only.
Measure	getPaddingLeft() This attribute is for internal use only.
Measure	getPaddingRight() This attribute is for internal use only.
Measure	getPaddingTop() This attribute is for internal use only.
Measure	getPreferredHeight()
Measure	getPreferredWidth()
Integer	getRowSpan()
Object	getState() Deprecated.
Measure	getTop() This value will usually be set by the layout manager.
Integer	getVerticalIndex() This attribute is for internal use only.
Measure	getWidth() The width of the component in the UI.
boolean	isOverflowX() This attribute is for internal use only.
boolean	isOverflowY() This attribute is for internal use only.
void	restoreState(javax.faces.context.FacesContext context, Object componentState)
Object	saveState(javax.faces.context.FacesContext context)
void	setApplicationIcon(String applicationIcon)
void	setBorderBottom(Measure borderBottom)
void	setBorderLeft(Measure borderLeft)
void	setBorderRight(Measure borderRight)
void	setBorderTop(Measure borderTop)
void	setColumnSpan(Integer columnSpan)
void	setCurrentHeight(Measure currentHeight)
void	setCurrentMarkup(Markup currentMarkup)
void	setCurrentWidth(Measure currentWidth)
void	setDisplay(Display display)
void	setFocusId(String focusId)
void	setHeight(Measure height)
void	setHorizontalIndex(Integer horizontalIndex)
void	setLabel(String label)
void	setLeft(Measure left)
void	setMarginBottom(Measure marginBottom)
void	setMarginLeft(Measure marginLeft)
void	setMarginRight(Measure marginRight)
void	setMarginTop(Measure marginTop)
void	setMarkup(Markup markup)
void	setMaximumHeight(Measure maximumHeight)
void	setMaximumWidth(Measure maximumWidth)
void	setMinimumHeight(Measure minimumHeight)
void	setMinimumWidth(Measure minimumWidth)
void	setOverflowX(boolean overflowX)
void	setOverflowY(boolean overflowY)
void	setPaddingBottom(Measure paddingBottom)
void	setPaddingLeft(Measure paddingLeft)
void	setPaddingRight(Measure paddingRight)
void	setPaddingTop(Measure paddingTop)
void	setPreferredHeight(Measure preferredHeight)
void	setPreferredWidth(Measure preferredWidth)
void	setRowSpan(Integer rowSpan)
void	setState(Object state) Deprecated.
void	setTop(Measure top)
void	setVerticalIndex(Integer verticalIndex)
void	setWidth(Measure width)

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIPage

encodeBegin, encodeChildren, encodeEnd, getActionId, getActionPosition, getComponents, getDefaultActionId, getFormId, getLayoutManager, getPageState, getPostfields, getRendersChildren, isLayoutChildren, markSubmittedForm, onComponentPopulated, processDecodes, processUpdates, setActionId, setActionPosition, setDefaultActionId, setLayoutManager, updatePageState

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIForm

invokeOnComponent, processValidators, setSubmitted

Methods inherited from class javax.faces.component.UIForm

getContainerClientId, getFamily, isPrependId, isSubmitted, setPrependId

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getValueExpression, setValueExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.tobago.config.Configurable

getRendererType

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIPage

public UIPage()

Method Detail

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface SupportsMarkup

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface SupportsMarkup

getMarginLeft

public Measure getMarginLeft()

Specified by:

getMarginLeft in interface LayoutBase

setMarginLeft

public void setMarginLeft(Measure marginLeft)

Specified by:

setMarginLeft in interface LayoutBase

getState

@Deprecated
public Object getState()

Deprecated.

ValueBindingExpression pointing to a object to save the component's state.

setState

@Deprecated
public void setState(Object state)

Deprecated.

getMinimumHeight

public Measure getMinimumHeight()

Specified by:

getMinimumHeight in interface LayoutBase

setMinimumHeight

public void setMinimumHeight(Measure minimumHeight)

Specified by:

setMinimumHeight in interface LayoutBase

getFocusId

public String getFocusId()

Contains the id of the component which should have the focus after loading the page. Set to empty string for disabling setting of focus. Default (null) enables the "auto focus" feature.

setFocusId

public void setFocusId(String focusId)

getBorderLeft

public Measure getBorderLeft()

This attribute is for internal use only.

Specified by:

getBorderLeft in interface LayoutBox

setBorderLeft

public void setBorderLeft(Measure borderLeft)

Specified by:

setBorderLeft in interface LayoutBox

getHeight

public Measure getHeight()

The height of the component in the UI. This value will usually be set by the layout manager, but can be set explicitly here.

Specified by:

getHeight in interface DeprecatedDimension

Specified by:

getHeight in interface LayoutBase

Specified by:

getHeight in class AbstractUIPage

setHeight

public void setHeight(Measure height)

Specified by:

setHeight in interface DeprecatedDimension

Specified by:

setHeight in interface LayoutBase

getMinimumWidth

public Measure getMinimumWidth()

Specified by:

getMinimumWidth in interface LayoutBase

setMinimumWidth

public void setMinimumWidth(Measure minimumWidth)

Specified by:

setMinimumWidth in interface LayoutBase

isOverflowX

public boolean isOverflowX()

This attribute is for internal use only.

Specified by:

isOverflowX in interface LayoutContainer

setOverflowX

public void setOverflowX(boolean overflowX)

Specified by:

setOverflowX in interface LayoutContainer

getRowSpan

public Integer getRowSpan()

setRowSpan

public void setRowSpan(Integer rowSpan)

isOverflowY

public boolean isOverflowY()

This attribute is for internal use only.

Specified by:

isOverflowY in interface LayoutContainer

setOverflowY

public void setOverflowY(boolean overflowY)

Specified by:

setOverflowY in interface LayoutContainer

getLeft

public Measure getLeft()

This value will usually be set by the layout manager.

Specified by:

getLeft in interface LayoutBase

setLeft

public void setLeft(Measure left)

Specified by:

setLeft in interface LayoutBase

getColumnSpan

public Integer getColumnSpan()

setColumnSpan

public void setColumnSpan(Integer columnSpan)

getBorderRight

public Measure getBorderRight()

This attribute is for internal use only.

Specified by:

getBorderRight in interface LayoutBox

setBorderRight

public void setBorderRight(Measure borderRight)

Specified by:

setBorderRight in interface LayoutBox

getPaddingBottom

public Measure getPaddingBottom()

This attribute is for internal use only.

Specified by:

getPaddingBottom in interface LayoutBox

setPaddingBottom

public void setPaddingBottom(Measure paddingBottom)

Specified by:

setPaddingBottom in interface LayoutBox

getMaximumHeight

public Measure getMaximumHeight()

Specified by:

getMaximumHeight in interface LayoutBase

setMaximumHeight

public void setMaximumHeight(Measure maximumHeight)

Specified by:

setMaximumHeight in interface LayoutBase

getTop

public Measure getTop()

This value will usually be set by the layout manager.

Specified by:

getTop in interface LayoutBase

setTop

public void setTop(Measure top)

Specified by:

setTop in interface LayoutBase

getCurrentWidth

public Measure getCurrentWidth()

This value will usually be set by the layout manager. It holds the current width computed by the layout manager.

Specified by:

getCurrentWidth in interface LayoutBase

setCurrentWidth

public void setCurrentWidth(Measure currentWidth)

Specified by:

setCurrentWidth in interface LayoutBase

getPaddingTop

public Measure getPaddingTop()

This attribute is for internal use only.

Specified by:

getPaddingTop in interface LayoutBox

setPaddingTop

public void setPaddingTop(Measure paddingTop)

Specified by:

setPaddingTop in interface LayoutBox

getMarginTop

public Measure getMarginTop()

Specified by:

getMarginTop in interface LayoutBase

setMarginTop

public void setMarginTop(Measure marginTop)

Specified by:

setMarginTop in interface LayoutBase

getMarginRight

public Measure getMarginRight()

Specified by:

getMarginRight in interface LayoutBase

setMarginRight

public void setMarginRight(Measure marginRight)

Specified by:

setMarginRight in interface LayoutBase

getWidth

public Measure getWidth()

The width of the component in the UI. This value will usually be set by the layout manager, but can be set explicitly here.

Specified by:

getWidth in interface DeprecatedDimension

Specified by:

getWidth in interface LayoutBase

Specified by:

getWidth in class AbstractUIPage

setWidth

public void setWidth(Measure width)

Specified by:

setWidth in interface DeprecatedDimension

Specified by:

setWidth in interface LayoutBase

getCurrentHeight

public Measure getCurrentHeight()

This value will usually be set by the layout manager. It holds the current height computed by the layout manager.

Specified by:

getCurrentHeight in interface LayoutBase

setCurrentHeight

public void setCurrentHeight(Measure currentHeight)

Specified by:

setCurrentHeight in interface LayoutBase

getPreferredHeight

public Measure getPreferredHeight()

Specified by:

getPreferredHeight in interface LayoutBase

setPreferredHeight

public void setPreferredHeight(Measure preferredHeight)

Specified by:

setPreferredHeight in interface LayoutBase

getDisplay

public Display getDisplay()

This attribute is for internal use only.

setDisplay

public void setDisplay(Display display)

getLabel

public String getLabel()

Text value to display as label. If text contains an underscore the next character is used as accesskey.

setLabel

public void setLabel(String label)

getBorderBottom

public Measure getBorderBottom()

This attribute is for internal use only.

Specified by:

getBorderBottom in interface LayoutBox

setBorderBottom

public void setBorderBottom(Measure borderBottom)

Specified by:

setBorderBottom in interface LayoutBox

getMaximumWidth

public Measure getMaximumWidth()

Specified by:

getMaximumWidth in interface LayoutBase

setMaximumWidth

public void setMaximumWidth(Measure maximumWidth)

Specified by:

setMaximumWidth in interface LayoutBase

getPaddingLeft

public Measure getPaddingLeft()

This attribute is for internal use only.

Specified by:

getPaddingLeft in interface LayoutBox

setPaddingLeft

public void setPaddingLeft(Measure paddingLeft)

Specified by:

setPaddingLeft in interface LayoutBox

getPaddingRight

public Measure getPaddingRight()

This attribute is for internal use only.

Specified by:

getPaddingRight in interface LayoutBox

setPaddingRight

public void setPaddingRight(Measure paddingRight)

Specified by:

setPaddingRight in interface LayoutBox

getPreferredWidth

public Measure getPreferredWidth()

Specified by:

getPreferredWidth in interface LayoutBase

setPreferredWidth

public void setPreferredWidth(Measure preferredWidth)

Specified by:

setPreferredWidth in interface LayoutBase

getMarginBottom

public Measure getMarginBottom()

Specified by:

getMarginBottom in interface LayoutBase

setMarginBottom

public void setMarginBottom(Measure marginBottom)

Specified by:

setMarginBottom in interface LayoutBase

getBorderTop

public Measure getBorderTop()

This attribute is for internal use only.

Specified by:

getBorderTop in interface LayoutBox

setBorderTop

public void setBorderTop(Measure borderTop)

Specified by:

setBorderTop in interface LayoutBox

getVerticalIndex

public Integer getVerticalIndex()

This attribute is for internal use only.

setVerticalIndex

public void setVerticalIndex(Integer verticalIndex)

getCurrentMarkup

public Markup getCurrentMarkup()

Specified by:

getCurrentMarkup in interface SupportsMarkup

Specified by:

getCurrentMarkup in interface Configurable

setCurrentMarkup

public void setCurrentMarkup(Markup currentMarkup)

Specified by:

setCurrentMarkup in interface SupportsMarkup

getApplicationIcon

public String getApplicationIcon()

Absolute URL to an image or image name to lookup in tobago resource path representing the application. In HTML it is used as a favicon.

setApplicationIcon

public void setApplicationIcon(String applicationIcon)

getHorizontalIndex

public Integer getHorizontalIndex()

This attribute is for internal use only.

setHorizontalIndex

public void setHorizontalIndex(Integer horizontalIndex)

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object componentState)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIForm

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIForm