org.apache.myfaces.custom.navigation
Class HtmlPanelNavigation

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              javax.faces.component.html.HtmlPanelGroup
                  org.apache.myfaces.custom.navigation.AbstractHtmlPanelNavigation
                      org.apache.myfaces.custom.navigation.HtmlPanelNavigation

All Implemented Interfaces:

javax.faces.component.StateHolder, AlignProperty, DataProperties, EventAware, PanelProperties, UniversalProperties

public class HtmlPanelNavigation
extends AbstractHtmlPanelNavigation

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

HtmlPanelNavigation()

Method Summary

java.lang.String	getActiveItemClass() The CSS class of the active navigation item.
java.lang.String	getActiveItemStyle() The CSS Style of the active navigation item.
java.lang.String	getAlign() HTML: Specifies the horizontal alignment of this element.
java.lang.String	getBgcolor() HTML: The background color of this element.
int	getBorder() HTML: Specifies the width of the border of this element, in pixels.
java.lang.String	getCellpadding() HTML: Specifies the amount of empty space between the cell border and its contents.
java.lang.String	getCellspacing() HTML: Specifies the amount of space between the cells of the table.
java.lang.String	getDatafld() Reserved for future use.
java.lang.String	getDataformatas() Reserved for future use.
java.lang.String	getDatasrc() Reserved for future use.
java.lang.String	getDir() HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
java.lang.String	getFamily()
java.lang.String	getFrame() HTML: Controls what part of the frame that surrounds a table is visible.
java.lang.String	getItemClass() The CSS class of closed navigation items.
java.lang.String	getItemStyle() The CSS Style of closed navigation items.
java.lang.String	getLang() HTML: The base language of this document.
java.lang.String	getOnclick() HTML: Script to be invoked when the element is clicked.
java.lang.String	getOndblclick() HTML: Script to be invoked when the element is double-clicked.
java.lang.String	getOnkeydown() HTML: Script to be invoked when a key is pressed down over this element.
java.lang.String	getOnkeypress() HTML: Script to be invoked when a key is pressed over this element.
java.lang.String	getOnkeyup() HTML: Script to be invoked when a key is released over this element.
java.lang.String	getOnmousedown() HTML: Script to be invoked when the pointing device is pressed over this element.
java.lang.String	getOnmousemove() HTML: Script to be invoked when the pointing device is moved while it is in this element.
java.lang.String	getOnmouseout() HTML: Script to be invoked when the pointing device is moves out of this element.
java.lang.String	getOnmouseover() HTML: Script to be invoked when the pointing device is moved into this element.
java.lang.String	getOnmouseup() HTML: Script to be invoked when the pointing device is released over this element.
java.lang.String	getOpenItemClass() The CSS class of open navigation items.
java.lang.String	getOpenItemStyle() The CSS Style of open navigation items.
java.lang.String	getRules() HTML: Controls how rules are rendered between cells.
java.lang.String	getSeparatorClass() The CSS class for the td element of a separator.
java.lang.String	getSeparatorStyle() The CSS Style for the td element of a separator.
java.lang.String	getSummary() HTML: Provides a summary of the contents of the table, for accessibility purposes.
java.lang.String	getTitle() HTML: An advisory title for this element.
java.lang.String	getWidth() HTML: Specifies the desired width of the table, as a pixel length or a percentage of available space.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setActiveItemClass(java.lang.String activeItemClass)
void	setActiveItemStyle(java.lang.String activeItemStyle)
void	setAlign(java.lang.String align)
void	setBgcolor(java.lang.String bgcolor)
void	setBorder(int border)
void	setCellpadding(java.lang.String cellpadding)
void	setCellspacing(java.lang.String cellspacing)
void	setDatafld(java.lang.String datafld)
void	setDataformatas(java.lang.String dataformatas)
void	setDatasrc(java.lang.String datasrc)
void	setDir(java.lang.String dir)
void	setFrame(java.lang.String frame)
void	setItemClass(java.lang.String itemClass)
void	setItemStyle(java.lang.String itemStyle)
void	setLang(java.lang.String lang)
void	setOnclick(java.lang.String onclick)
void	setOndblclick(java.lang.String ondblclick)
void	setOnkeydown(java.lang.String onkeydown)
void	setOnkeypress(java.lang.String onkeypress)
void	setOnkeyup(java.lang.String onkeyup)
void	setOnmousedown(java.lang.String onmousedown)
void	setOnmousemove(java.lang.String onmousemove)
void	setOnmouseout(java.lang.String onmouseout)
void	setOnmouseover(java.lang.String onmouseover)
void	setOnmouseup(java.lang.String onmouseup)
void	setOpenItemClass(java.lang.String openItemClass)
void	setOpenItemStyle(java.lang.String openItemStyle)
void	setRules(java.lang.String rules)
void	setSeparatorClass(java.lang.String separatorClass)
void	setSeparatorStyle(java.lang.String separatorStyle)
void	setSummary(java.lang.String summary)
void	setTitle(java.lang.String title)
void	setWidth(java.lang.String width)

Methods inherited from class org.apache.myfaces.custom.navigation.AbstractHtmlPanelNavigation

decode, encodeBegin, restoreOpenActiveStates

Methods inherited from class javax.faces.component.html.HtmlPanelGroup

getLayout, getStyle, getStyleClass, setLayout, setStyle, setStyleClass

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, 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

encodeAll, getContainerClientId, getValueExpression, setValueExpression

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlPanelNavigation

public HtmlPanelNavigation()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.html.HtmlPanelGroup

getItemClass

public java.lang.String getItemClass()

Description copied from class: AbstractHtmlPanelNavigation

The CSS class of closed navigation items.

Specified by:

getItemClass in class AbstractHtmlPanelNavigation

setItemClass

public void setItemClass(java.lang.String itemClass)

getOpenItemClass

public java.lang.String getOpenItemClass()

Description copied from class: AbstractHtmlPanelNavigation

The CSS class of open navigation items.

Specified by:

getOpenItemClass in class AbstractHtmlPanelNavigation

setOpenItemClass

public void setOpenItemClass(java.lang.String openItemClass)

getActiveItemClass

public java.lang.String getActiveItemClass()

Description copied from class: AbstractHtmlPanelNavigation

The CSS class of the active navigation item.

Specified by:

getActiveItemClass in class AbstractHtmlPanelNavigation

setActiveItemClass

public void setActiveItemClass(java.lang.String activeItemClass)

getSeparatorClass

public java.lang.String getSeparatorClass()

Description copied from class: AbstractHtmlPanelNavigation

The CSS class for the td element of a separator.

Specified by:

getSeparatorClass in class AbstractHtmlPanelNavigation

setSeparatorClass

public void setSeparatorClass(java.lang.String separatorClass)

getItemStyle

public java.lang.String getItemStyle()

Description copied from class: AbstractHtmlPanelNavigation

The CSS Style of closed navigation items.

Specified by:

getItemStyle in class AbstractHtmlPanelNavigation

setItemStyle

public void setItemStyle(java.lang.String itemStyle)

getOpenItemStyle

public java.lang.String getOpenItemStyle()

Description copied from class: AbstractHtmlPanelNavigation

The CSS Style of open navigation items.

Specified by:

getOpenItemStyle in class AbstractHtmlPanelNavigation

setOpenItemStyle

public void setOpenItemStyle(java.lang.String openItemStyle)

getActiveItemStyle

public java.lang.String getActiveItemStyle()

Description copied from class: AbstractHtmlPanelNavigation

The CSS Style of the active navigation item.

Specified by:

getActiveItemStyle in class AbstractHtmlPanelNavigation

setActiveItemStyle

public void setActiveItemStyle(java.lang.String activeItemStyle)

getSeparatorStyle

public java.lang.String getSeparatorStyle()

Description copied from class: AbstractHtmlPanelNavigation

The CSS Style for the td element of a separator.

Specified by:

getSeparatorStyle in class AbstractHtmlPanelNavigation

setSeparatorStyle

public void setSeparatorStyle(java.lang.String separatorStyle)

getOnclick

public java.lang.String getOnclick()

Description copied from interface: EventAware

HTML: Script to be invoked when the element is clicked.

setOnclick

public void setOnclick(java.lang.String onclick)

getOndblclick

public java.lang.String getOndblclick()

Description copied from interface: EventAware

HTML: Script to be invoked when the element is double-clicked.

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

getOnkeydown

public java.lang.String getOnkeydown()

Description copied from interface: EventAware

HTML: Script to be invoked when a key is pressed down over this element.

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

getOnkeypress

public java.lang.String getOnkeypress()

Description copied from interface: EventAware

HTML: Script to be invoked when a key is pressed over this element.

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

getOnkeyup

public java.lang.String getOnkeyup()

Description copied from interface: EventAware

HTML: Script to be invoked when a key is released over this element.

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

getOnmousedown

public java.lang.String getOnmousedown()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is pressed over this element.

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

getOnmousemove

public java.lang.String getOnmousemove()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is moved while it is in this element.

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

getOnmouseout

public java.lang.String getOnmouseout()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is moves out of this element.

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

getOnmouseover

public java.lang.String getOnmouseover()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is moved into this element.

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

getOnmouseup

public java.lang.String getOnmouseup()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is released over this element.

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

getDir

public java.lang.String getDir()

Description copied from interface: UniversalProperties

HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

setDir

public void setDir(java.lang.String dir)

getLang

public java.lang.String getLang()

Description copied from interface: UniversalProperties

HTML: The base language of this document.

setLang

public void setLang(java.lang.String lang)

getTitle

public java.lang.String getTitle()

Description copied from interface: UniversalProperties

HTML: An advisory title for this element. Often used by the user agent as a tooltip.

setTitle

public void setTitle(java.lang.String title)

getDatafld

public java.lang.String getDatafld()

Description copied from interface: DataProperties

Reserved for future use.

setDatafld

public void setDatafld(java.lang.String datafld)

getDatasrc

public java.lang.String getDatasrc()

Description copied from interface: DataProperties

Reserved for future use.

setDatasrc

public void setDatasrc(java.lang.String datasrc)

getDataformatas

public java.lang.String getDataformatas()

Description copied from interface: DataProperties

Reserved for future use.

setDataformatas

public void setDataformatas(java.lang.String dataformatas)

getBgcolor

public java.lang.String getBgcolor()

Description copied from interface: PanelProperties

HTML: The background color of this element.

setBgcolor

public void setBgcolor(java.lang.String bgcolor)

getBorder

public int getBorder()

Description copied from interface: PanelProperties

HTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.

setBorder

public void setBorder(int border)

getCellpadding

public java.lang.String getCellpadding()

Description copied from interface: PanelProperties

HTML: Specifies the amount of empty space between the cell border and its contents. It can be either a pixel length or a percentage.

setCellpadding

public void setCellpadding(java.lang.String cellpadding)

getCellspacing

public java.lang.String getCellspacing()

Description copied from interface: PanelProperties

HTML: Specifies the amount of space between the cells of the table. It can be either a pixel length or a percentage of available space.

setCellspacing

public void setCellspacing(java.lang.String cellspacing)

getFrame

public java.lang.String getFrame()

Description copied from interface: PanelProperties

HTML: Controls what part of the frame that surrounds a table is visible. Values include: void, above, below, hsides, lhs, rhs, vsides, box, and border.

setFrame

public void setFrame(java.lang.String frame)

getRules

public java.lang.String getRules()

Description copied from interface: PanelProperties

HTML: Controls how rules are rendered between cells. Values include: none, groups, rows, cols, and all.

setRules

public void setRules(java.lang.String rules)

getSummary

public java.lang.String getSummary()

Description copied from interface: PanelProperties

HTML: Provides a summary of the contents of the table, for accessibility purposes.

setSummary

public void setSummary(java.lang.String summary)

getWidth

public java.lang.String getWidth()

Description copied from interface: PanelProperties

HTML: Specifies the desired width of the table, as a pixel length or a percentage of available space.

setWidth

public void setWidth(java.lang.String width)

getAlign

public java.lang.String getAlign()

Description copied from interface: AlignProperty

HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.

setAlign

public void setAlign(java.lang.String align)

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.html.HtmlPanelGroup

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.html.HtmlPanelGroup