Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.richfaces.component.html
Class HtmlToolBarGroup

    java.lang.Object
      javax.faces.component.UIComponent
          javax.faces.component.UIComponentBase
              org.richfaces.component.UIToolBarGroup
                  org.richfaces.component.html.HtmlToolBarGroup

All Implemented Interfaces:
  javax.faces.component.StateHolder

    public class HtmlToolBarGroup

extends UIToolBarGroup

Component-Type org.richfaces.ToolBarGroup Component-Family org.richfaces.ToolBar Renderer-Type org.richfaces.ToolBarGroupRenderer A group of items inside a tool bar. The group item is separated basing on the "itemSeparator" attribute. Location of a group on a tool bar is set up with the "location" attribute.

Field Summary
`static java.lang.String` | `COMPONENT_FAMILY`
`static java.lang.String` | `COMPONENT_TYPE`

Constructor Summary
`HtmlToolBarGroup()` Constructor to init default renderers

Method Summary
`java.lang.String` | `getFamily()`
`java.lang.String` | `getItemSeparator()` "A separator for the items in a group.
`java.lang.String` | `getLocation()` "A location of a group on a tool bar.
`java.lang.String` | `getSeparatorClass()` "A CSS class to be applied to tool bar group separators." Getter for separatorClass
`java.lang.String` | `getStyle()` CSS style(s) is/are to be applied when this component is rendered Getter for style
`java.lang.String` | `getStyleClass()` Corresponds to the HTML class attribute Getter for styleClass
`void` | `restoreState(javax.faces.context.FacesContext context, java.lang.Object state)`
`java.lang.Object` | `saveState(javax.faces.context.FacesContext context)`
`void` | `setItemSeparator(java.lang.String __itemSeparator)` "A separator for the items in a group.
`void` | `setLocation(java.lang.String __location)` "A location of a group on a tool bar.
`void` | `setSeparatorClass(java.lang.String __separatorClass)` "A CSS class to be applied to tool bar group separators." Setter for separatorClass
`void` | `setStyle(java.lang.String __style)` CSS style(s) is/are to be applied when this component is rendered Setter for style
`void` | `setStyleClass(java.lang.String __styleClass)` Corresponds to the HTML class attribute Setter for styleClass

Methods inherited from class org.richfaces.component.UIToolBarGroup
`getToolBar`

Methods inherited from class javax.faces.component.UIComponentBase
`addFacesListener, broadcast, 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, queueEvent, 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_TYPE

    public static final java.lang.String COMPONENT_TYPE

See Also:
  Constant Field Values

### COMPONENT_FAMILY

    public static final java.lang.String COMPONENT_FAMILY

See Also:
  Constant Field Values

Constructor Detail

### HtmlToolBarGroup

    public HtmlToolBarGroup()

  Constructor to init default renderers

Method Detail

### setStyleClass

    public void setStyleClass(java.lang.String __styleClass)

  Corresponds to the HTML class attribute Setter for styleClass

  Parameters:
    `styleClass` - - new value

### getStyleClass

    public java.lang.String getStyleClass()

  Corresponds to the HTML class attribute Getter for styleClass

  Returns:
    styleClass value from local variable or value bindings

### setStyle

    public void setStyle(java.lang.String __style)

  CSS style(s) is/are to be applied when this component is rendered Setter for style

  Parameters:
    `style` - - new value

### getStyle

    public java.lang.String getStyle()

  CSS style(s) is/are to be applied when this component is rendered Getter for style

  Returns:
    style value from local variable or value bindings

### setSeparatorClass

    public void setSeparatorClass(java.lang.String __separatorClass)

  "A CSS class to be applied to tool bar group separators." Setter for separatorClass

  Parameters:
    `separatorClass` - - new value

### getSeparatorClass

    public java.lang.String getSeparatorClass()

  "A CSS class to be applied to tool bar group separators." Getter for separatorClass

  Returns:
    separatorClass value from local variable or value bindings

### setLocation

    public void setLocation(java.lang.String __location)

  "A location of a group on a tool bar. Possible values are "left" and "right"." Setter for location

  Specified by:
    `setLocation` in class `UIToolBarGroup`
  Parameters:
    `location` - - new value

### getLocation

    public java.lang.String getLocation()

  "A location of a group on a tool bar. Possible values are "left" and "right"." Getter for location

  Specified by:
    `getLocation` in class `UIToolBarGroup`
  Returns:
    location value from local variable or value bindings

### setItemSeparator

    public void setItemSeparator(java.lang.String __itemSeparator)

  "A separator for the items in a group. Possible values are "none", "line", "square", "disc" and "grid"." Setter for itemSeparator

  Specified by:
    `setItemSeparator` in class `UIToolBarGroup`
  Parameters:
    `itemSeparator` - - new value

### getItemSeparator

    public java.lang.String getItemSeparator()

  "A separator for the items in a group. Possible values are "none", "line", "square", "disc" and "grid"." Getter for itemSeparator

  Specified by:
    `getItemSeparator` in class `UIToolBarGroup`
  Returns:
    itemSeparator value from local variable or value bindings

### getFamily

    public java.lang.String getFamily()

  Specified by:
    `getFamily` in class `javax.faces.component.UIComponent`

### 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.UIComponentBase`

### 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 `javax.faces.component.UIComponentBase`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2007. All Rights Reserved.