org.apache.myfaces.custom.tabbedpane
Class AbstractHtmlPanelTabbedPane

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              javax.faces.component.html.HtmlPanelGroup
                  org.apache.myfaces.custom.tabbedpane.AbstractHtmlPanelTabbedPane

All Implemented Interfaces:

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

public abstract class AbstractHtmlPanelTabbedPane
extends javax.faces.component.html.HtmlPanelGroup
implements UniversalProperties, EventAware, PanelProperties, AlignProperty, DataProperties, UserRoleAware

TODO: Document this component. Unless otherwise specified, all attributes accept static values or EL expressions.

Version:

$Revision: 745263 $ $Date: 2009-02-17 16:51:58 -0500 (Tue, 17 Feb 2009) $

Author:

Manfred Geiler (latest modification by $Author: lu4242 $)

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

AbstractHtmlPanelTabbedPane()

Method Summary

void	addTabChangeListener(TabChangeListener listener)
void	broadcast(javax.faces.event.FacesEvent event)
void	decode(javax.faces.context.FacesContext context)
abstract Boolean	getActivePanelTabVar() Boolean Variable that is set in request scope when rendering a panelTab.
abstract String	getActiveSubStyleClass() Style class of the active tab sub cell.
abstract String	getActiveTabStyleClass() Style class of the active tab cell.
abstract String	getActiveTabVar()
abstract String	getDisabledTabStyleClass() Style class of the disabled tab cells.
abstract String	getInactiveSubStyleClass() Style class of the inactive tab sub cells.
abstract String	getInactiveTabStyleClass() Style class of the inactive tab cells.
abstract int	getSelectedIndex() Index of tab that is selected by default.
boolean	getServerSideTabSwitch()
javax.faces.el.MethodBinding	getTabChangeListener() TODO: This should be something like this: JSFProperty returnSignature = "void" methodSignature = "org.apache.myfaces.custom.tabbedpane.TabChangeEvent" And be added on tld.
abstract String	getTabContentStyleClass() Style class of the active tab content cell.
boolean	isClientSide() Write out information about the toggling mode - the component might be toggled server side or client side.
abstract 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).
abstract boolean	isServerSideTabSwitch() Toggle client-side/server-side tab switches.
void	processDecodes(javax.faces.context.FacesContext context)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent event)
void	removeTabChangeListener(TabChangeListener listener)
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
abstract void	setSelectedIndex(int selectedIndex)
void	setTabChangeListener(javax.faces.el.MethodBinding tabChangeListener)

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

getStyle, getStyleClass, setStyle, setStyleClass

Methods inherited from class javax.faces.component.UIPanel

getFamily

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

Methods inherited from interface org.apache.myfaces.component.UniversalProperties

getDir, getLang, getTitle

Methods inherited from interface org.apache.myfaces.component.EventAware

getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup

Methods inherited from interface org.apache.myfaces.component.PanelProperties

getBgcolor, getBorder, getCellpadding, getCellspacing, getFrame, getRules, getSummary, getWidth

Methods inherited from interface org.apache.myfaces.component.AlignProperty

getAlign

Methods inherited from interface org.apache.myfaces.component.DataProperties

getDatafld, getDataformatas, getDatasrc

Methods inherited from interface org.apache.myfaces.component.UserRoleAware

getEnabledOnUserRole, getVisibleOnUserRole, setEnabledOnUserRole, setVisibleOnUserRole

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

AbstractHtmlPanelTabbedPane

public AbstractHtmlPanelTabbedPane()

Method Detail

decode

public void decode(javax.faces.context.FacesContext context)

Overrides:

decode in class javax.faces.component.UIComponentBase

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class javax.faces.component.UIComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class javax.faces.component.UIComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class javax.faces.component.UIComponentBase

addTabChangeListener

public void addTabChangeListener(TabChangeListener listener)

removeTabChangeListener

public void removeTabChangeListener(TabChangeListener listener)

getTabChangeListener

public javax.faces.el.MethodBinding getTabChangeListener()

TODO: This should be something like this: JSFProperty returnSignature = "void" methodSignature = "org.apache.myfaces.custom.tabbedpane.TabChangeEvent" And be added on tld. But you can do the same with TabChangeListenerTag.

Returns:

setTabChangeListener

public void setTabChangeListener(javax.faces.el.MethodBinding tabChangeListener)

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.html.HtmlPanelGroup

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

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

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

isClientSide

public boolean isClientSide()

Write out information about the toggling mode - the component might be toggled server side or client side.

getActiveTabVar

public abstract String getActiveTabVar()

getActivePanelTabVar

public abstract Boolean getActivePanelTabVar()

Boolean Variable that is set in request scope when rendering a panelTab. True means that the currently rendered panelTab is active.

getSelectedIndex

public abstract int getSelectedIndex()

Index of tab that is selected by default.

setSelectedIndex

public abstract void setSelectedIndex(int selectedIndex)

getActiveTabStyleClass

public abstract String getActiveTabStyleClass()

Style class of the active tab cell.

getInactiveTabStyleClass

public abstract String getInactiveTabStyleClass()

Style class of the inactive tab cells.

getActiveSubStyleClass

public abstract String getActiveSubStyleClass()

Style class of the active tab sub cell.

getInactiveSubStyleClass

public abstract String getInactiveSubStyleClass()

Style class of the inactive tab sub cells.

getTabContentStyleClass

public abstract String getTabContentStyleClass()

Style class of the active tab content cell.

getDisabledTabStyleClass

public abstract String getDisabledTabStyleClass()

Style class of the disabled tab cells.

isServerSideTabSwitch

public abstract boolean isServerSideTabSwitch()

Toggle client-side/server-side tab switches.

getServerSideTabSwitch

public boolean getServerSideTabSwitch()

isImmediateTabChange

public abstract 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). 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.

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase