public class

UITreeMenu

extends AbstractUITree
implements SupportsMarkup
java.lang.Object
   ↳ javax.faces.component.UIComponent
     ↳ javax.faces.component.UIComponentBase
       ↳ javax.faces.component.UIOutput
         ↳ javax.faces.component.UIInput
           ↳ org.apache.myfaces.tobago.internal.component.AbstractUITree
             ↳ org.apache.myfaces.tobago.component.UITreeMenu

Class Overview

A tree which will be displayed like a flat menu. This menu is often used for navigation on the left side of an application. UIComponent class, generated from template component1.2.stg with class org.apache.myfaces.tobago.internal.taglib.component.TreeMenuTagDeclaration.

Summary

Constants
String COMPONENT_TYPE
[Expand]
Inherited Constants
From class org.apache.myfaces.tobago.internal.component.AbstractUITree
From class javax.faces.component.UIInput
From class javax.faces.component.UIOutput
From interface javax.faces.component.NamingContainer
[Expand]
Inherited Fields
From class javax.faces.component.UIComponent
Public Constructors
UITreeMenu()
Public Methods
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.
Measure getHeight()
This value will usually be set by the layout manager.
Integer getHorizontalIndex()
This attribute is for internal use only.
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 getPreferredHeight()
Measure getPreferredWidth()
Integer getRowSpan()
Object getState()
ValueBindingExpression pointing to a object to save the component's state.
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.
boolean isShowRoot()
Indicates that the root node should be displayed or not.
void restoreState(FacesContext context, Object componentState)
Object saveState(FacesContext context)
void setColumnSpan(Integer columnSpan)
void setCurrentHeight(Measure currentHeight)
void setCurrentMarkup(Markup currentMarkup)
void setCurrentWidth(Measure currentWidth)
void setDisplay(Display display)
void setHeight(Measure height)
void setHorizontalIndex(Integer horizontalIndex)
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 setPreferredHeight(Measure preferredHeight)
void setPreferredWidth(Measure preferredWidth)
void setRowSpan(Integer rowSpan)
void setShowRoot(boolean showRoot)
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.AbstractUITree
From class javax.faces.component.UIInput
From class javax.faces.component.UIOutput
From class javax.faces.component.UIComponentBase
From class javax.faces.component.UIComponent
From class java.lang.Object
From interface javax.faces.component.EditableValueHolder
From interface javax.faces.component.StateHolder
From interface javax.faces.component.ValueHolder
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.LayoutComponent

Constants

public static final String COMPONENT_TYPE

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

Public Constructors

public UITreeMenu ()

Public Methods

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 Measure getHeight ()

This value will usually be set by the layout manager.

public Integer getHorizontalIndex ()

This attribute is for internal use only.

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 getPreferredHeight ()

public Measure getPreferredWidth ()

public Integer getRowSpan ()

public Object getState ()

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

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.

public boolean isShowRoot ()

Indicates that the root node should be displayed or not. Normally the root node of a menu will not be shown, because it has only technical significance.
Default: false

public void restoreState (FacesContext context, Object componentState)

public Object saveState (FacesContext context)

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 setHeight (Measure height)

public void setHorizontalIndex (Integer horizontalIndex)

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 setPreferredHeight (Measure preferredHeight)

public void setPreferredWidth (Measure preferredWidth)

public void setRowSpan (Integer rowSpan)

public void setShowRoot (boolean showRoot)

public void setState (Object state)

public void setTop (Measure top)

public void setVerticalIndex (Integer verticalIndex)

public void setWidth (Measure width)