org.apache.myfaces.custom.tabbedpane
Class HtmlPanelTabbedPane

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIPanel
              extended by javax.faces.component.html.HtmlPanelGroup
                  extended by org.apache.myfaces.custom.tabbedpane.AbstractHtmlPanelTabbedPane
                      extended by org.apache.myfaces.custom.tabbedpane.HtmlPanelTabbedPane
All Implemented Interfaces:
javax.faces.component.StateHolder, AlignProperty, DataProperties, EventAware, PanelProperties, UniversalProperties, UserRoleAware

public class HtmlPanelTabbedPane
extends AbstractHtmlPanelTabbedPane


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
HtmlPanelTabbedPane()
           
 
Method Summary
 java.lang.Boolean getActivePanelTabVar()
          Boolean Variable that is set in request scope when rendering a panelTab.
 java.lang.String getActiveSubStyleClass()
          Style class of the active tab sub cell.
 java.lang.String getActiveTabStyleClass()
          Style class of the active tab cell.
 java.lang.String getActiveTabVar()
           
 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 getDisabledTabStyleClass()
          Style class of the disabled tab cells.
 java.lang.String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 java.lang.String getFamily()
           
 java.lang.String getFrame()
          HTML: Controls what part of the frame that surrounds a table is visible.
 java.lang.String getInactiveSubStyleClass()
          Style class of the inactive tab sub cells.
 java.lang.String getInactiveTabStyleClass()
          Style class of the inactive tab cells.
 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 getRules()
          HTML: Controls how rules are rendered between cells.
 int getSelectedIndex()
          Index of tab that is selected by default.
 java.lang.String getSummary()
          HTML: Provides a summary of the contents of the table, for accessibility purposes.
 java.lang.String getTabContentStyleClass()
          Style class of the active tab content cell.
 java.lang.String getTitle()
          HTML: An advisory title for this element.
 java.lang.String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 java.lang.String getWidth()
          HTML: Specifies the desired width of the table, as a pixel length or a percentage of available space.
 boolean isImmediateTabChange()
          Define if the process validation and update model phases should be executed before change between tabs, when serverSideTabSwitch = true (if is false, the switch is done by other way so this property does not have any effect).
 boolean isServerSideTabSwitch()
          Toggle client-side/server-side tab switches.
 void restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
           
 void setActivePanelTabVar(java.lang.Boolean activePanelTabVar)
           
 void setActiveSubStyleClass(java.lang.String activeSubStyleClass)
           
 void setActiveTabStyleClass(java.lang.String activeTabStyleClass)
           
 void setActiveTabVar(java.lang.String activeTabVar)
           
 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 setDisabledTabStyleClass(java.lang.String disabledTabStyleClass)
           
 void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
           
 void setFrame(java.lang.String frame)
           
 void setImmediateTabChange(boolean immediateTabChange)
           
 void setInactiveSubStyleClass(java.lang.String inactiveSubStyleClass)
           
 void setInactiveTabStyleClass(java.lang.String inactiveTabStyleClass)
           
 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 setRules(java.lang.String rules)
           
 void setSelectedIndex(int selectedIndex)
           
 void setServerSideTabSwitch(boolean serverSideTabSwitch)
           
 void setSummary(java.lang.String summary)
           
 void setTabContentStyleClass(java.lang.String tabContentStyleClass)
           
 void setTitle(java.lang.String title)
           
 void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
           
 void setWidth(java.lang.String width)
           
 
Methods inherited from class org.apache.myfaces.custom.tabbedpane.AbstractHtmlPanelTabbedPane
addTabChangeListener, broadcast, decode, getServerSideTabSwitch, getTabChangeListener, isClientSide, processDecodes, processUpdates, processValidators, queueEvent, removeTabChangeListener, setTabChangeListener
 
Methods inherited from class javax.faces.component.html.HtmlPanelGroup
getStyle, getStyleClass, setStyle, setStyleClass
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
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

HtmlPanelTabbedPane

public HtmlPanelTabbedPane()
Method Detail

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UIPanel

getActiveTabVar

public java.lang.String getActiveTabVar()
Specified by:
getActiveTabVar in class AbstractHtmlPanelTabbedPane

setActiveTabVar

public void setActiveTabVar(java.lang.String activeTabVar)

getActivePanelTabVar

public java.lang.Boolean getActivePanelTabVar()
Description copied from class: AbstractHtmlPanelTabbedPane
Boolean Variable that is set in request scope when rendering a panelTab. True means that the currently rendered panelTab is active.

Specified by:
getActivePanelTabVar in class AbstractHtmlPanelTabbedPane

setActivePanelTabVar

public void setActivePanelTabVar(java.lang.Boolean activePanelTabVar)

getSelectedIndex

public int getSelectedIndex()
Description copied from class: AbstractHtmlPanelTabbedPane
Index of tab that is selected by default.

Specified by:
getSelectedIndex in class AbstractHtmlPanelTabbedPane

setSelectedIndex

public void setSelectedIndex(int selectedIndex)
Specified by:
setSelectedIndex in class AbstractHtmlPanelTabbedPane

getActiveTabStyleClass

public java.lang.String getActiveTabStyleClass()
Description copied from class: AbstractHtmlPanelTabbedPane
Style class of the active tab cell.

Specified by:
getActiveTabStyleClass in class AbstractHtmlPanelTabbedPane

setActiveTabStyleClass

public void setActiveTabStyleClass(java.lang.String activeTabStyleClass)

getInactiveTabStyleClass

public java.lang.String getInactiveTabStyleClass()
Description copied from class: AbstractHtmlPanelTabbedPane
Style class of the inactive tab cells.

Specified by:
getInactiveTabStyleClass in class AbstractHtmlPanelTabbedPane

setInactiveTabStyleClass

public void setInactiveTabStyleClass(java.lang.String inactiveTabStyleClass)

getActiveSubStyleClass

public java.lang.String getActiveSubStyleClass()
Description copied from class: AbstractHtmlPanelTabbedPane
Style class of the active tab sub cell.

Specified by:
getActiveSubStyleClass in class AbstractHtmlPanelTabbedPane

setActiveSubStyleClass

public void setActiveSubStyleClass(java.lang.String activeSubStyleClass)

getInactiveSubStyleClass

public java.lang.String getInactiveSubStyleClass()
Description copied from class: AbstractHtmlPanelTabbedPane
Style class of the inactive tab sub cells.

Specified by:
getInactiveSubStyleClass in class AbstractHtmlPanelTabbedPane

setInactiveSubStyleClass

public void setInactiveSubStyleClass(java.lang.String inactiveSubStyleClass)

getTabContentStyleClass

public java.lang.String getTabContentStyleClass()
Description copied from class: AbstractHtmlPanelTabbedPane
Style class of the active tab content cell.

Specified by:
getTabContentStyleClass in class AbstractHtmlPanelTabbedPane

setTabContentStyleClass

public void setTabContentStyleClass(java.lang.String tabContentStyleClass)

getDisabledTabStyleClass

public java.lang.String getDisabledTabStyleClass()
Description copied from class: AbstractHtmlPanelTabbedPane
Style class of the disabled tab cells.

Specified by:
getDisabledTabStyleClass in class AbstractHtmlPanelTabbedPane

setDisabledTabStyleClass

public void setDisabledTabStyleClass(java.lang.String disabledTabStyleClass)

isServerSideTabSwitch

public boolean isServerSideTabSwitch()
Description copied from class: AbstractHtmlPanelTabbedPane
Toggle client-side/server-side tab switches.

Specified by:
isServerSideTabSwitch in class AbstractHtmlPanelTabbedPane

setServerSideTabSwitch

public void setServerSideTabSwitch(boolean serverSideTabSwitch)

isImmediateTabChange

public boolean isImmediateTabChange()
Description copied from class: AbstractHtmlPanelTabbedPane
Define if the process validation and update model phases should be executed before change between tabs, when serverSideTabSwitch = true (if is false, the switch is done by other way so this property does not have any effect). Note that if this property is set as false, only a tab change is done if all input fields inside the form are valid (including input components outside this panel). By default is true, so both phases are not executed.

Specified by:
isImmediateTabChange in class AbstractHtmlPanelTabbedPane

setImmediateTabChange

public void setImmediateTabChange(boolean immediateTabChange)

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)

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)

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 AbstractHtmlPanelTabbedPane

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 AbstractHtmlPanelTabbedPane


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.