org.apache.myfaces.custom.accordion
Class AbstractHtmlAccordionPanel

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.component.html.ext.AbstractHtmlPanelGroup
                      extended by org.apache.myfaces.component.html.ext.HtmlPanelGroup
                          extended by org.apache.myfaces.custom.accordion.AbstractHtmlAccordionPanel
All Implemented Interfaces:
javax.faces.component.StateHolder, org.apache.myfaces.component.DisplayValueOnlyAware, org.apache.myfaces.component.EventAware, org.apache.myfaces.component.ForceIdAware, org.apache.myfaces.component.UniversalProperties, org.apache.myfaces.component.UserRoleAware, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

public abstract class AbstractHtmlAccordionPanel
extends org.apache.myfaces.component.html.ext.HtmlPanelGroup

A group of panels, which can be opened and closed. See attribute layout for further description on how opening and closing works. Extends standard panelGroup by user role support.

Version:
$Revision: 663481 $ $Date: 2008-06-05 02:00:34 -0500 (Thu, 05 Jun 2008) $

Author:
Martin Marinschek

Field Summary
static java.lang.String ACCORDION_LAYOUT
           
static java.lang.String BORDER_COLOR
           
static java.lang.String COLLAPSED_BACK_COLOR
           
static java.lang.String COLLAPSED_FONT_WEIGHT
           
static java.lang.String COLLAPSED_TEXT_COLOR
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
static java.lang.String EXPAND_STATEHOLDER_ID
           
static java.lang.String EXPANDED_BACK_COLOR
           
static java.lang.String EXPANDED_FONT_WEIGHT
           
static java.lang.String EXPANDED_TEXT_COLOR
           
static java.lang.String HOVER_BACK_COLOR
           
static java.lang.String HOVER_TEXT_COLOR
           
static java.lang.String TOGGLING_LAYOUT
           
 
Fields inherited from class org.apache.myfaces.component.html.ext.HtmlPanelGroup
COMPONENT_FAMILY
 
Fields inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlPanelGroup
BLOCK_LAYOUT, DEFAULT_COLSPAN
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable
DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR
 
Constructor Summary
AbstractHtmlAccordionPanel()
           
 
Method Summary
abstract  java.lang.String getBorderColor()
          Defines the color of the border.
 java.util.List getChildExpanded()
           
abstract  java.lang.String getCollapsedBackColor()
          Defines the background color for collapsed state.
abstract  java.lang.String getCollapsedFontWeight()
          Defines the font weight for collapsed state.
abstract  java.lang.String getCollapsedTextColor()
          Defines the text color for collapsed state.
abstract  java.lang.String getExpandedBackColor()
          Defines the background color for expanded state.
abstract  java.lang.String getExpandedFontWeight()
          Defines the font weight for expanded state.
abstract  java.lang.String getExpandedTextColor()
          Defines the text color for expanded state.
abstract  java.lang.String getHoverBackColor()
          Defines the background color on hover.
abstract  java.lang.String getHoverTextColor()
          Defines the text color on hover.
abstract  java.lang.String getLayout()
          Defines the layout of this accordionPanel.
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setChildExpanded(java.util.List childExpanded)
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlPanelGroup
getColspan, getDir, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getFamily, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTitle, getVisibleOnUserRole, isForceId, isForceIdIndex, setColspan, setDir, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, setLang, setLayout, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTitle, setVisibleOnUserRole
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlPanelGroup
getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly
 
Methods inherited from class javax.faces.component.html.HtmlPanelGroup
getStyle, getStyleClass, setStyle, setStyleClass
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, 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

ACCORDION_LAYOUT

public static java.lang.String ACCORDION_LAYOUT

TOGGLING_LAYOUT

public static java.lang.String TOGGLING_LAYOUT

EXPANDED_BACK_COLOR

public static java.lang.String EXPANDED_BACK_COLOR

EXPANDED_TEXT_COLOR

public static java.lang.String EXPANDED_TEXT_COLOR

EXPANDED_FONT_WEIGHT

public static java.lang.String EXPANDED_FONT_WEIGHT

COLLAPSED_BACK_COLOR

public static java.lang.String COLLAPSED_BACK_COLOR

COLLAPSED_TEXT_COLOR

public static java.lang.String COLLAPSED_TEXT_COLOR

COLLAPSED_FONT_WEIGHT

public static java.lang.String COLLAPSED_FONT_WEIGHT

HOVER_BACK_COLOR

public static java.lang.String HOVER_BACK_COLOR

HOVER_TEXT_COLOR

public static java.lang.String HOVER_TEXT_COLOR

BORDER_COLOR

public static java.lang.String BORDER_COLOR

EXPAND_STATEHOLDER_ID

public static java.lang.String EXPAND_STATEHOLDER_ID

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

AbstractHtmlAccordionPanel

public AbstractHtmlAccordionPanel()
Method Detail

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class org.apache.myfaces.component.html.ext.HtmlPanelGroup

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class org.apache.myfaces.component.html.ext.HtmlPanelGroup

getLayout

public abstract java.lang.String getLayout()
Defines the layout of this accordionPanel. If you set this to 'accordion', opening a panel will close all other panels. If you set this to 'toggling', opening a panel doesn't affect the state of the other panels. You can close a panel by clicking on the header of this panel a second time.

Overrides:
getLayout in class org.apache.myfaces.component.html.ext.HtmlPanelGroup

getExpandedBackColor

public abstract java.lang.String getExpandedBackColor()
Defines the background color for expanded state.


getExpandedTextColor

public abstract java.lang.String getExpandedTextColor()
Defines the text color for expanded state.


getExpandedFontWeight

public abstract java.lang.String getExpandedFontWeight()
Defines the font weight for expanded state.


getCollapsedBackColor

public abstract java.lang.String getCollapsedBackColor()
Defines the background color for collapsed state.


getCollapsedTextColor

public abstract java.lang.String getCollapsedTextColor()
Defines the text color for collapsed state.


getCollapsedFontWeight

public abstract java.lang.String getCollapsedFontWeight()
Defines the font weight for collapsed state.


getHoverBackColor

public abstract java.lang.String getHoverBackColor()
Defines the background color on hover.


getHoverTextColor

public abstract java.lang.String getHoverTextColor()
Defines the text color on hover.


getBorderColor

public abstract java.lang.String getBorderColor()
Defines the color of the border.


getChildExpanded

public java.util.List getChildExpanded()

setChildExpanded

public void setChildExpanded(java.util.List childExpanded)


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