public class

UIPage

extends AbstractUIPage
implements SupportsMarkup
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

Class Overview

Renders a page element. UIComponent class, generated from template component1.2.stg with class org.apache.myfaces.tobago.internal.taglib.component.PageTagDeclaration.

Summary

Constants
String COMPONENT_TYPE
[Expand]
Inherited Constants
From class org.apache.myfaces.tobago.internal.component.AbstractUIPage
From class org.apache.myfaces.tobago.internal.component.AbstractUIForm
From class javax.faces.component.UIForm
From interface javax.faces.component.NamingContainer
From interface org.apache.myfaces.tobago.component.OnComponentPopulated
[Expand]
Inherited Fields
From class javax.faces.component.UIComponent
Public Constructors
UIPage()
Public Methods
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()
This value will usually be set by the layout manager.@deprecated
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()
ValueBindingExpression pointing to a object to save the component's state.@deprecated
Measure getTop()
This value will usually be set by the layout manager.
Integer getVerticalIndex()
This attribute is for internal use only.
Measure getWidth()
This value will usually be set by the layout manager.@deprecated
boolean isOverflowX()
This attribute is for internal use only.
boolean isOverflowY()
This attribute is for internal use only.
void restoreState(FacesContext context, Object componentState)
Object saveState(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)
void setTop(Measure top)
void setVerticalIndex(Integer verticalIndex)
void setWidth(Measure width)
[Expand]
Inherited Methods
From class org.apache.myfaces.tobago.internal.component.AbstractUIPage
From class org.apache.myfaces.tobago.internal.component.AbstractUIForm
From class javax.faces.component.UIForm
From class javax.faces.component.UIComponentBase
From class javax.faces.component.UIComponent
From class java.lang.Object
From interface javax.faces.component.StateHolder
From interface org.apache.myfaces.tobago.compat.InvokeOnComponent
From interface org.apache.myfaces.tobago.component.DeprecatedDimension
From interface org.apache.myfaces.tobago.component.OnComponentPopulated
From interface org.apache.myfaces.tobago.component.SupportsMarkup
From interface org.apache.myfaces.tobago.config.Configurable
From interface org.apache.myfaces.tobago.layout.LayoutBase
From interface org.apache.myfaces.tobago.layout.LayoutBox
From interface org.apache.myfaces.tobago.layout.LayoutContainer

Constants

public static final String COMPONENT_TYPE

Constant Value: "org.apache.myfaces.tobago.Page"

Public Constructors

public UIPage ()

Public Methods

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.

public Measure getBorderBottom ()

This attribute is for internal use only.

public Measure getBorderLeft ()

This attribute is for internal use only.

public Measure getBorderRight ()

This attribute is for internal use only.

public Measure getBorderTop ()

This attribute is for internal use only.

public Integer getColumnSpan ()

public Measure getCurrentHeight ()

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

public Markup getCurrentMarkup ()

public Measure getCurrentWidth ()

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

public Display getDisplay ()

This attribute is for internal use only.

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.

public Measure getHeight ()

This value will usually be set by the layout manager.@deprecated

public Integer getHorizontalIndex ()

This attribute is for internal use only.

public String getLabel ()

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

public Measure getLeft ()

This value will usually be set by the layout manager.

public Measure getMarginBottom ()

public Measure getMarginLeft ()

public Measure getMarginRight ()

public Measure getMarginTop ()

public Markup getMarkup ()

public Measure getMaximumHeight ()

public Measure getMaximumWidth ()

public Measure getMinimumHeight ()

public Measure getMinimumWidth ()

public Measure getPaddingBottom ()

This attribute is for internal use only.

public Measure getPaddingLeft ()

This attribute is for internal use only.

public Measure getPaddingRight ()

This attribute is for internal use only.

public Measure getPaddingTop ()

This attribute is for internal use only.

public Measure getPreferredHeight ()

public Measure getPreferredWidth ()

public Integer getRowSpan ()

public Object getState ()

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

public Measure getTop ()

This value will usually be set by the layout manager.

public Integer getVerticalIndex ()

This attribute is for internal use only.

public Measure getWidth ()

This value will usually be set by the layout manager.@deprecated

public boolean isOverflowX ()

This attribute is for internal use only.

public boolean isOverflowY ()

This attribute is for internal use only.

public void restoreState (FacesContext context, Object componentState)

public Object saveState (FacesContext context)

public void setApplicationIcon (String applicationIcon)

public void setBorderBottom (Measure borderBottom)

public void setBorderLeft (Measure borderLeft)

public void setBorderRight (Measure borderRight)

public void setBorderTop (Measure borderTop)

public void setColumnSpan (Integer columnSpan)

public void setCurrentHeight (Measure currentHeight)

public void setCurrentMarkup (Markup currentMarkup)

public void setCurrentWidth (Measure currentWidth)

public void setDisplay (Display display)

public void setFocusId (String focusId)

public void setHeight (Measure height)

public void setHorizontalIndex (Integer horizontalIndex)

public void setLabel (String label)

public void setLeft (Measure left)

public void setMarginBottom (Measure marginBottom)

public void setMarginLeft (Measure marginLeft)

public void setMarginRight (Measure marginRight)

public void setMarginTop (Measure marginTop)

public void setMarkup (Markup markup)

public void setMaximumHeight (Measure maximumHeight)

public void setMaximumWidth (Measure maximumWidth)

public void setMinimumHeight (Measure minimumHeight)

public void setMinimumWidth (Measure minimumWidth)

public void setOverflowX (boolean overflowX)

public void setOverflowY (boolean overflowY)

public void setPaddingBottom (Measure paddingBottom)

public void setPaddingLeft (Measure paddingLeft)

public void setPaddingRight (Measure paddingRight)

public void setPaddingTop (Measure paddingTop)

public void setPreferredHeight (Measure preferredHeight)

public void setPreferredWidth (Measure preferredWidth)

public void setRowSpan (Integer rowSpan)

public void setState (Object state)

public void setTop (Measure top)

public void setVerticalIndex (Integer verticalIndex)

public void setWidth (Measure width)