org.richfaces.component
Class UITab

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by org.ajax4jsf.framework.ajax.AjaxActionComponent
                  extended by org.richfaces.component.UITab
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.StateHolder, org.ajax4jsf.framework.ajax.AjaxComponent, org.ajax4jsf.framework.ajax.AjaxSource, TabModel
Direct Known Subclasses:
HtmlTab

public abstract class UITab
extends org.ajax4jsf.framework.ajax.AjaxActionComponent
implements TabModel, org.ajax4jsf.framework.ajax.AjaxComponent, org.ajax4jsf.framework.ajax.AjaxSource, javax.faces.component.ActionSource

Base class for panel tab.

Version:
$Revision: 1.12 $ $Date: 2007/02/21 20:35:05 $
Author:
asmirnov@exadel.com (latest modification by $Author: ishabalov $)

Field Summary
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UICommand
COMPONENT_FAMILY
 
Fields inherited from interface org.ajax4jsf.framework.ajax.AjaxComponent
AJAX_COMPONETT_PARAMETER
 
Constructor Summary
UITab()
           
 
Method Summary
 void encodeTab(javax.faces.context.FacesContext context, boolean active)
           
abstract  java.lang.String getLabel()
          Get label for this tab.
abstract  java.lang.String getLabelWidth()
          Get width of label for this tab.
abstract  java.lang.Object getName()
          Get Get internal value for this tab - to store in selectedTab attribute of UITabPanelPane.
 UITabPanel getPane()
          Get enclosed UITabPanelPane tab panel for this component.
 java.lang.String getSwitchType()
          Get Tab selection behavior for panel - one of "client", "server", "ajax", "page".
abstract  java.lang.String getTitle()
          Get Tab title - for pop-up message.
abstract  java.lang.Object getValue()
          Get Model Value for this Tab.
 boolean isActive()
           
abstract  boolean isDisabled()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object object)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setActive(boolean active)
           
abstract  void setDisabled(boolean disabled)
           
abstract  void setLabel(java.lang.String newvalue)
          Set label for this tab.
abstract  void setLabelWidth(java.lang.String newvalue)
          Set width of label for this tab.
abstract  void setName(java.lang.Object newvalue)
          Set Get internal value for this tab - to store in selectedTab attribute of UITabPanelPane.
 void setSwitchType(java.lang.String newvalue)
          Set Tab selection behavior for panel - one of "client", "server", "ajax", "page".
abstract  void setTitle(java.lang.String newvalue)
          Set Tab title - for pop-up message.
protected  void setupReRender()
           
abstract  void setValue(java.lang.Object newvalue)
          Set Model Value for this Tab.
 
Methods inherited from class org.ajax4jsf.framework.ajax.AjaxActionComponent
addAjaxListener, broadcast, getAjaxListeners, queueEvent, removeAjaxListener, setupReRender
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, getAction, getActionListener, getActionListeners, getFamily, isImmediate, removeActionListener, setAction, setActionListener, setImmediate
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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.ajax4jsf.framework.ajax.AjaxComponent
getData, getEventsQueue, getOncomplete, getRequestDelay, getReRender, getStatus, getTimeout, isAjaxSingle, isBypassUpdates, isIgnoreDupResponses, isLimitToList, setAjaxSingle, setBypassUpdates, setData, setEventsQueue, setIgnoreDupResponses, setLimitToList, setOncomplete, setRequestDelay, setReRender, setStatus, setTimeout
 
Methods inherited from interface org.ajax4jsf.framework.ajax.AjaxSource
addAjaxListener, getAjaxListeners, removeAjaxListener
 
Methods inherited from interface javax.faces.component.ActionSource
addActionListener, getAction, getActionListener, getActionListeners, isImmediate, removeActionListener, setAction, setActionListener, setImmediate
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

UITab

public UITab()
Method Detail

encodeTab

public void encodeTab(javax.faces.context.FacesContext context,
                      boolean active)
               throws java.io.IOException
Parameters:
context -
active -
Throws:
java.io.IOException

getPane

public UITabPanel getPane()
                   throws javax.faces.FacesException
Get enclosed UITabPanelPane tab panel for this component.

Returns:
Throws:
javax.faces.FacesException

setupReRender

protected void setupReRender()
Overrides:
setupReRender in class org.ajax4jsf.framework.ajax.AjaxActionComponent

isActive

public boolean isActive()
Returns:
Returns the active.

setActive

public void setActive(boolean active)
Parameters:
active - The active to set. This method should never be called from user code.

getValue

public abstract java.lang.Object getValue()
Get Model Value for this Tab.

Overrides:
getValue in class javax.faces.component.UICommand
Returns:

setValue

public abstract void setValue(java.lang.Object newvalue)
Set Model Value for this Tab.

Overrides:
setValue in class javax.faces.component.UICommand
Parameters:
newvalue -

getName

public abstract java.lang.Object getName()
Description copied from interface: TabModel
Get Get internal value for this tab - to store in selectedTab attribute of UITabPanelPane. by default, if no tabValue set, as it's value used ordered number of this tab in panel.

Specified by:
getName in interface TabModel
Returns:

setName

public abstract void setName(java.lang.Object newvalue)
Description copied from interface: TabModel
Set Get internal value for this tab - to store in selectedTab attribute of UITabPanelPane.

Specified by:
setName in interface TabModel

isDisabled

public abstract boolean isDisabled()
Specified by:
isDisabled in interface TabModel

setDisabled

public abstract void setDisabled(boolean disabled)
Specified by:
setDisabled in interface TabModel

getLabel

public abstract java.lang.String getLabel()
Description copied from interface: TabModel
Get label for this tab.

Specified by:
getLabel in interface TabModel
Returns:

setLabel

public abstract void setLabel(java.lang.String newvalue)
Description copied from interface: TabModel
Set label for this tab.

Specified by:
setLabel in interface TabModel

getLabelWidth

public abstract java.lang.String getLabelWidth()
Description copied from interface: TabModel
Get width of label for this tab.

Specified by:
getLabelWidth in interface TabModel
Returns:

setLabelWidth

public abstract void setLabelWidth(java.lang.String newvalue)
Description copied from interface: TabModel
Set width of label for this tab.

Specified by:
setLabelWidth in interface TabModel

getTitle

public abstract java.lang.String getTitle()
Description copied from interface: TabModel
Get Tab title - for pop-up message.

Specified by:
getTitle in interface TabModel
Returns:

setTitle

public abstract void setTitle(java.lang.String newvalue)
Description copied from interface: TabModel
Set Tab title - for pop-up message.

Specified by:
setTitle in interface TabModel

getSwitchType

public java.lang.String getSwitchType()
Description copied from interface: TabModel
Get Tab selection behavior for panel - one of "client", "server", "ajax", "page".

Specified by:
getSwitchType in interface TabModel
Returns:

setSwitchType

public void setSwitchType(java.lang.String newvalue)
Description copied from interface: TabModel
Set Tab selection behavior for panel - one of "client", "server", "ajax", "page".

Specified by:
setSwitchType in interface TabModel

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UICommand

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object object)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UICommand


Copyright © 2007. All Rights Reserved.