org.apache.myfaces.custom.collapsiblepanel
Class HtmlCollapsiblePanel

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by org.apache.myfaces.custom.collapsiblepanel.AbstractHtmlCollapsiblePanel
                      extended by org.apache.myfaces.custom.collapsiblepanel.HtmlCollapsiblePanel
All Implemented Interfaces:
java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, EventAware, StyleAware, UniversalProperties, UserRoleAware

public class HtmlCollapsiblePanel
extends AbstractHtmlCollapsiblePanel


Nested Class Summary
protected static class HtmlCollapsiblePanel.PropertyKeys
           
 
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.UIInput
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
HtmlCollapsiblePanel()
           
 
Method Summary
 java.lang.String getDir()
          HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 java.lang.String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 java.util.Collection<java.lang.String> getEventNames()
           
 java.lang.String getFamily()
           
 java.lang.String getIndicatorStyle()
          HTML: CSS styling instructions for the generated indicator.
 java.lang.String getIndicatorStyleClass()
          The CSS class for this element.
 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 getStyle()
          HTML: CSS styling instructions.
 java.lang.String getStyleClass()
          The CSS class for this element.
 java.lang.String getTitle()
          HTML: An advisory title for this element.
 java.lang.String getTitleStyle()
          HTML: CSS styling instructions for the generated title.
 java.lang.String getTitleStyleClass()
          The CSS class for this element.
 java.lang.String getTitleVar()
          This variable is defined to hold the value of the title component - you can use it for accessing this value in custom headers you define in a facet with name 'header'.
 java.lang.String getVar()
          The variable which you can use to check for the collapsed state of the enclosing component.
 java.lang.String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 void setDir(java.lang.String dir)
           
 void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
           
 void setIndicatorStyle(java.lang.String indicatorStyle)
           
 void setIndicatorStyleClass(java.lang.String indicatorStyleClass)
           
 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 setStyle(java.lang.String style)
           
 void setStyleClass(java.lang.String styleClass)
           
 void setTitle(java.lang.String title)
           
 void setTitleStyle(java.lang.String titleStyle)
           
 void setTitleStyleClass(java.lang.String titleStyleClass)
           
 void setTitleVar(java.lang.String titleVar)
           
 void setVar(java.lang.String var)
           
 void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
           
 
Methods inherited from class org.apache.myfaces.custom.collapsiblepanel.AbstractHtmlCollapsiblePanel
encodeChildren, getClientId, getClosedContent, getHeader, getValidator, getValueChangeListener, isCollapsed, isCollapsed, isCurrentlyCollapsed, isImmediate, isRequired, processDecodes, processUpdates, processValidators, setClosedContent, setCurrentlyCollapsed, setHeader, updateModel
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidatorMessage, getValidators, getValue, getValueChangeListeners, isEmpty, isLocalValueSet, isValid, markInitialState, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, validate, validateValue
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, encodeBegin, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
 

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

HtmlCollapsiblePanel

public HtmlCollapsiblePanel()
Method Detail

getFamily

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

getEventNames

public java.util.Collection<java.lang.String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getEventNames in class javax.faces.component.UIComponentBase

getVar

public java.lang.String getVar()
Description copied from class: AbstractHtmlCollapsiblePanel
The variable which you can use to check for the collapsed state of the enclosing component. This is especially useful for custom headers you define in a facet with name 'header'.

Specified by:
getVar in class AbstractHtmlCollapsiblePanel

setVar

public void setVar(java.lang.String var)

getTitleVar

public java.lang.String getTitleVar()
Description copied from class: AbstractHtmlCollapsiblePanel
This variable is defined to hold the value of the title component - you can use it for accessing this value in custom headers you define in a facet with name 'header'.

Specified by:
getTitleVar in class AbstractHtmlCollapsiblePanel

setTitleVar

public void setTitleVar(java.lang.String titleVar)

getIndicatorStyleClass

public java.lang.String getIndicatorStyleClass()
Description copied from class: AbstractHtmlCollapsiblePanel
The CSS class for this element. Corresponds to the HTML 'class' attribute for the generated indicator span. This attribute is ignored if a custom "header" facet is provided for the collapsible panel

Specified by:
getIndicatorStyleClass in class AbstractHtmlCollapsiblePanel
Returns:

setIndicatorStyleClass

public void setIndicatorStyleClass(java.lang.String indicatorStyleClass)

getIndicatorStyle

public java.lang.String getIndicatorStyle()
Description copied from class: AbstractHtmlCollapsiblePanel
HTML: CSS styling instructions for the generated indicator. This attribute is ignored if a custom "header" facet is provided for the collapsible panel

Specified by:
getIndicatorStyle in class AbstractHtmlCollapsiblePanel
Returns:

setIndicatorStyle

public void setIndicatorStyle(java.lang.String indicatorStyle)

getTitleStyleClass

public java.lang.String getTitleStyleClass()
Description copied from class: AbstractHtmlCollapsiblePanel
The CSS class for this element. Corresponds to the HTML 'class' attribute for the generated title. This attribute is ignored if a custom "header" facet is provided for the collapsible panel

Specified by:
getTitleStyleClass in class AbstractHtmlCollapsiblePanel
Returns:

setTitleStyleClass

public void setTitleStyleClass(java.lang.String titleStyleClass)

getTitleStyle

public java.lang.String getTitleStyle()
Description copied from class: AbstractHtmlCollapsiblePanel
HTML: CSS styling instructions for the generated title. This attribute is ignored if a custom "header" facet is provided for the collapsible panel

Specified by:
getTitleStyle in class AbstractHtmlCollapsiblePanel
Returns:

setTitleStyle

public void setTitleStyle(java.lang.String titleStyle)

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)

getStyle

public java.lang.String getStyle()
Description copied from interface: StyleAware
HTML: CSS styling instructions.


setStyle

public void setStyle(java.lang.String style)

getStyleClass

public java.lang.String getStyleClass()
Description copied from interface: StyleAware
The CSS class for this element. Corresponds to the HTML 'class' attribute.


setStyleClass

public void setStyleClass(java.lang.String styleClass)


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