com.sun.rave.web.ui.component
Class TableActions

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.sun.rave.web.ui.component.TableActionsBase
              com.sun.rave.web.ui.component.TableActions

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class TableActions

extends TableActionsBase

implements javax.faces.component.NamingContainer

Component that represents a table action bar.

Note: Column headers and footers are rendered by TableRowGroupRenderer. Table column footers are rendered by TableRenderer.

Note: To see the messages logged by this class, set the following global defaults in your JDK's "jre/lib/logging.properties" file.

 java.util.logging.ConsoleHandler.level = FINE
 com.sun.rave.web.ui.component.TableActions.level = FINE
 

Field Summary

static java.lang.String	ACTIONS_SEPARATOR_ICON_FACET The facet name for the actions separator icon.
static java.lang.String	ACTIONS_SEPARATOR_ICON_ID The component id for the actions separator icon.
static java.lang.String	CLEAR_SORT_BUTTON_FACET The facet name for the clear sort button.
static java.lang.String	CLEAR_SORT_BUTTON_ID The component id for the clear sort button.
static java.lang.String	DESELECT_MULTIPLE_BUTTON_FACET The facet name for the deselect multiple button.
static java.lang.String	DESELECT_MULTIPLE_BUTTON_ID The component id for the deselect multiple button.
static java.lang.String	DESELECT_SINGLE_BUTTON_FACET The facet name for the deselect single button.
static java.lang.String	DESELECT_SINGLE_BUTTON_ID The component id for the deselect single button.
static java.lang.String	FILTER_LABEL_FACET The facet name for the filter label.
static java.lang.String	FILTER_LABEL_ID The component id for the filter label.
static java.lang.String	FILTER_SEPARATOR_ICON_FACET The facet name for the filter separator icon.
static java.lang.String	FILTER_SEPARATOR_ICON_ID The component id for the filter separator icon.
static java.lang.String	PAGINATE_BUTTON_FACET The facet name for the paginate button.
static java.lang.String	PAGINATE_BUTTON_ID The component id for the paginate button.
static java.lang.String	PAGINATE_SEPARATOR_ICON_FACET The facet name for the paginate separator icon.
static java.lang.String	PAGINATE_SEPARATOR_ICON_ID The component id for the paginate separator icon.
static java.lang.String	PAGINATION_FIRST_BUTTON_FACET The facet name for the pagination first button.
static java.lang.String	PAGINATION_FIRST_BUTTON_ID The component id for the pagination first button.
static java.lang.String	PAGINATION_LAST_BUTTON_FACET The facet name for the pagination last button.
static java.lang.String	PAGINATION_LAST_BUTTON_ID The component id for the pagination last button.
static java.lang.String	PAGINATION_NEXT_BUTTON_FACET The facet name for the pagination next button.
static java.lang.String	PAGINATION_NEXT_BUTTON_ID The component id for the pagination next button.
static java.lang.String	PAGINATION_PAGE_FIELD_FACET The facet name for the pagination page field.
static java.lang.String	PAGINATION_PAGE_FIELD_ID The component id for the pagination page field.
static java.lang.String	PAGINATION_PAGES_TEXT_FACET The facet name for the pagination pages text.
static java.lang.String	PAGINATION_PAGES_TEXT_ID The component id for the pagination pages text.
static java.lang.String	PAGINATION_PREV_BUTTON_FACET The facet name for the pagination previous button.
static java.lang.String	PAGINATION_PREV_BUTTON_ID The component id for the pagination previous button.
static java.lang.String	PAGINATION_SUBMIT_BUTTON_FACET The facet name for the pagination submit button.
static java.lang.String	PAGINATION_SUBMIT_BUTTON_ID The component id for the pagination submit button.
static java.lang.String	PREFERENCES_PANEL_TOGGLE_BUTTON_FACET The facet name for the preferences panel button.
static java.lang.String	PREFERENCES_PANEL_TOGGLE_BUTTON_ID The component id for the preferences panel button.
static java.lang.String	SELECT_MULTIPLE_BUTTON_FACET The facet name for the select multiple button.
static java.lang.String	SELECT_MULTIPLE_BUTTON_ID The component id for the select multiple button.
static java.lang.String	SORT_PANEL_TOGGLE_BUTTON_FACET The facet name for the sort panel toggle button.
static java.lang.String	SORT_PANEL_TOGGLE_BUTTON_ID The component id for the sort panel toggle button.
static java.lang.String	VIEW_ACTIONS_SEPARATOR_ICON_FACET The facet name for the view actions separator icon.
static java.lang.String	VIEW_ACTIONS_SEPARATOR_ICON_ID The component id for the view actions separator icon.

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

TableActions()
Default constructor

Method Summary

void	encodeBegin(javax.faces.context.FacesContext context) If the rendered property is true, render the begining of the current state of this UIComponent to the response contained in the specified FacesContext.
javax.faces.component.UIComponent	getActionsSeparatorIcon() Get the actions separator icon.
javax.faces.component.UIComponent	getClearSortButton() Get clear sort button.
javax.faces.component.UIComponent	getDeselectMultipleButton() Get deselect multiple button.
javax.faces.component.UIComponent	getDeselectSingleButton() Get deselect single button.
javax.faces.component.UIComponent	getFilterLabel() Get filter label.
javax.faces.component.UIComponent	getFilterSeparatorIcon() Get the filter separator icon.
javax.faces.component.UIComponent	getPaginateButton() Get paginate button of pagination controls.
javax.faces.component.UIComponent	getPaginateSeparatorIcon() Get the paginate separator icon.
javax.faces.component.UIComponent	getPaginationFirstButton() Get first page button for pagination controls.
javax.faces.component.UIComponent	getPaginationLastButton() Get last page button for pagination controls.
javax.faces.component.UIComponent	getPaginationNextButton() Get next page button for pagination controls.
javax.faces.component.UIComponent	getPaginationPageField() Get page field for pagination controls.
javax.faces.component.UIComponent	getPaginationPagesText() Get pages text for pagination controls.
javax.faces.component.UIComponent	getPaginationPrevButton() Get previous page button for pagination controls.
javax.faces.component.UIComponent	getPaginationSubmitButton() Get pagination submit button for pagination controls.
javax.faces.component.UIComponent	getPreferencesPanelToggleButton() Get preferences panel toggle button.
javax.faces.component.UIComponent	getSelectMultipleButton() Get select multiple button.
javax.faces.component.UIComponent	getSortPanelToggleButton() Get sort panel toggle button.
Table	getTableAncestor() Get the closest Table ancestor that encloses this component.
javax.faces.component.UIComponent	getViewActionsSeparatorIcon() Get the view actions separator icon.

Methods inherited from class com.sun.rave.web.ui.component.TableActionsBase

getAbbr, getAlign, getAxis, getBgColor, getChar, getCharOff, getColSpan, getExtraHtml, getFamily, getHeaders, getHeight, getOnClick, getOnDblClick, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getRowSpan, getScope, getStyle, getStyleClass, getToolTip, getValign, getWidth, isActionsBottom, isNoWrap, isVisible, restoreState, saveState, setAbbr, setActionsBottom, setAlign, setAxis, setBgColor, setChar, setCharOff, setColSpan, setExtraHtml, setHeaders, setHeight, setNoWrap, setOnClick, setOnDblClick, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setRowSpan, setScope, setStyle, setStyleClass, setToolTip, setValign, setVisible, setWidth

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, 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

ACTIONS_SEPARATOR_ICON_ID

public static final java.lang.String ACTIONS_SEPARATOR_ICON_ID

The component id for the actions separator icon.

See Also:

Constant Field Values

ACTIONS_SEPARATOR_ICON_FACET

public static final java.lang.String ACTIONS_SEPARATOR_ICON_FACET

The facet name for the actions separator icon.

See Also:

Constant Field Values

CLEAR_SORT_BUTTON_ID

public static final java.lang.String CLEAR_SORT_BUTTON_ID

The component id for the clear sort button.

See Also:

Constant Field Values

CLEAR_SORT_BUTTON_FACET

public static final java.lang.String CLEAR_SORT_BUTTON_FACET

The facet name for the clear sort button.

See Also:

Constant Field Values

DESELECT_MULTIPLE_BUTTON_ID

public static final java.lang.String DESELECT_MULTIPLE_BUTTON_ID

The component id for the deselect multiple button.

See Also:

Constant Field Values

DESELECT_MULTIPLE_BUTTON_FACET

public static final java.lang.String DESELECT_MULTIPLE_BUTTON_FACET

The facet name for the deselect multiple button.

See Also:

Constant Field Values

DESELECT_SINGLE_BUTTON_ID

public static final java.lang.String DESELECT_SINGLE_BUTTON_ID

The component id for the deselect single button.

See Also:

Constant Field Values

DESELECT_SINGLE_BUTTON_FACET

public static final java.lang.String DESELECT_SINGLE_BUTTON_FACET

The facet name for the deselect single button.

See Also:

Constant Field Values

FILTER_LABEL_ID

public static final java.lang.String FILTER_LABEL_ID

The component id for the filter label.

See Also:

Constant Field Values

FILTER_LABEL_FACET

public static final java.lang.String FILTER_LABEL_FACET

The facet name for the filter label.

See Also:

Constant Field Values

FILTER_SEPARATOR_ICON_ID

public static final java.lang.String FILTER_SEPARATOR_ICON_ID

The component id for the filter separator icon.

See Also:

Constant Field Values

FILTER_SEPARATOR_ICON_FACET

public static final java.lang.String FILTER_SEPARATOR_ICON_FACET

The facet name for the filter separator icon.

See Also:

Constant Field Values

PAGINATE_BUTTON_ID

public static final java.lang.String PAGINATE_BUTTON_ID

The component id for the paginate button.

See Also:

Constant Field Values

PAGINATE_BUTTON_FACET

public static final java.lang.String PAGINATE_BUTTON_FACET

The facet name for the paginate button.

See Also:

Constant Field Values

PAGINATE_SEPARATOR_ICON_ID

public static final java.lang.String PAGINATE_SEPARATOR_ICON_ID

The component id for the paginate separator icon.

See Also:

Constant Field Values

PAGINATE_SEPARATOR_ICON_FACET

public static final java.lang.String PAGINATE_SEPARATOR_ICON_FACET

The facet name for the paginate separator icon.

See Also:

Constant Field Values

PAGINATION_FIRST_BUTTON_ID

public static final java.lang.String PAGINATION_FIRST_BUTTON_ID

The component id for the pagination first button.

See Also:

Constant Field Values

PAGINATION_FIRST_BUTTON_FACET

public static final java.lang.String PAGINATION_FIRST_BUTTON_FACET

The facet name for the pagination first button.

See Also:

Constant Field Values

PAGINATION_LAST_BUTTON_ID

public static final java.lang.String PAGINATION_LAST_BUTTON_ID

The component id for the pagination last button.

See Also:

Constant Field Values

PAGINATION_LAST_BUTTON_FACET

public static final java.lang.String PAGINATION_LAST_BUTTON_FACET

The facet name for the pagination last button.

See Also:

Constant Field Values

PAGINATION_NEXT_BUTTON_ID

public static final java.lang.String PAGINATION_NEXT_BUTTON_ID

The component id for the pagination next button.

See Also:

Constant Field Values

PAGINATION_NEXT_BUTTON_FACET

public static final java.lang.String PAGINATION_NEXT_BUTTON_FACET

The facet name for the pagination next button.

See Also:

Constant Field Values

PAGINATION_PAGE_FIELD_ID

public static final java.lang.String PAGINATION_PAGE_FIELD_ID

The component id for the pagination page field.

See Also:

Constant Field Values

PAGINATION_PAGE_FIELD_FACET

public static final java.lang.String PAGINATION_PAGE_FIELD_FACET

The facet name for the pagination page field.

See Also:

Constant Field Values

PAGINATION_PAGES_TEXT_ID

public static final java.lang.String PAGINATION_PAGES_TEXT_ID

The component id for the pagination pages text.

See Also:

Constant Field Values

PAGINATION_PAGES_TEXT_FACET

public static final java.lang.String PAGINATION_PAGES_TEXT_FACET

The facet name for the pagination pages text.

See Also:

Constant Field Values

PAGINATION_PREV_BUTTON_ID

public static final java.lang.String PAGINATION_PREV_BUTTON_ID

The component id for the pagination previous button.

See Also:

Constant Field Values

PAGINATION_PREV_BUTTON_FACET

public static final java.lang.String PAGINATION_PREV_BUTTON_FACET

The facet name for the pagination previous button.

See Also:

Constant Field Values

PAGINATION_SUBMIT_BUTTON_ID

public static final java.lang.String PAGINATION_SUBMIT_BUTTON_ID

The component id for the pagination submit button.

See Also:

Constant Field Values

PAGINATION_SUBMIT_BUTTON_FACET

public static final java.lang.String PAGINATION_SUBMIT_BUTTON_FACET

The facet name for the pagination submit button.

See Also:

Constant Field Values

PREFERENCES_PANEL_TOGGLE_BUTTON_ID

public static final java.lang.String PREFERENCES_PANEL_TOGGLE_BUTTON_ID

The component id for the preferences panel button.

See Also:

Constant Field Values

PREFERENCES_PANEL_TOGGLE_BUTTON_FACET

public static final java.lang.String PREFERENCES_PANEL_TOGGLE_BUTTON_FACET

The facet name for the preferences panel button.

See Also:

Constant Field Values

SELECT_MULTIPLE_BUTTON_ID

public static final java.lang.String SELECT_MULTIPLE_BUTTON_ID

The component id for the select multiple button.

See Also:

Constant Field Values

SELECT_MULTIPLE_BUTTON_FACET

public static final java.lang.String SELECT_MULTIPLE_BUTTON_FACET

The facet name for the select multiple button.

See Also:

Constant Field Values

SORT_PANEL_TOGGLE_BUTTON_ID

public static final java.lang.String SORT_PANEL_TOGGLE_BUTTON_ID

The component id for the sort panel toggle button.

See Also:

Constant Field Values

SORT_PANEL_TOGGLE_BUTTON_FACET

public static final java.lang.String SORT_PANEL_TOGGLE_BUTTON_FACET

The facet name for the sort panel toggle button.

See Also:

Constant Field Values

VIEW_ACTIONS_SEPARATOR_ICON_ID

public static final java.lang.String VIEW_ACTIONS_SEPARATOR_ICON_ID

The component id for the view actions separator icon.

See Also:

Constant Field Values

VIEW_ACTIONS_SEPARATOR_ICON_FACET

public static final java.lang.String VIEW_ACTIONS_SEPARATOR_ICON_FACET

The facet name for the view actions separator icon.

See Also:

Constant Field Values

Constructor Detail

TableActions

public TableActions()

Default constructor

Method Detail

getTableAncestor

public Table getTableAncestor()

Get the closest Table ancestor that encloses this component.

Returns:

The Table ancestor.

getPaginationFirstButton

public javax.faces.component.UIComponent getPaginationFirstButton()

Get first page button for pagination controls.

Returns:

The first page button.

getPaginationSubmitButton

public javax.faces.component.UIComponent getPaginationSubmitButton()

Get pagination submit button for pagination controls.

Returns:

The pagination submit button.

getPaginationLastButton

public javax.faces.component.UIComponent getPaginationLastButton()

Get last page button for pagination controls.

Returns:

The last page button.

getPaginationNextButton

public javax.faces.component.UIComponent getPaginationNextButton()

Get next page button for pagination controls.

Returns:

The next page button.

getPaginationPageField

public javax.faces.component.UIComponent getPaginationPageField()

Get page field for pagination controls.

Returns:

The page field.

getPaginationPagesText

public javax.faces.component.UIComponent getPaginationPagesText()

Get pages text for pagination controls.

Returns:

The pages text.

getPaginateButton

public javax.faces.component.UIComponent getPaginateButton()

Get paginate button of pagination controls.

Returns:

The paginate button.

getPaginationPrevButton

public javax.faces.component.UIComponent getPaginationPrevButton()

Get previous page button for pagination controls.

Returns:

The previous page button.

getDeselectMultipleButton

public javax.faces.component.UIComponent getDeselectMultipleButton()

Get deselect multiple button.

Returns:

The deselect multiple button.

getDeselectSingleButton

public javax.faces.component.UIComponent getDeselectSingleButton()

Get deselect single button.

Returns:

The deselect single button.

getSelectMultipleButton

public javax.faces.component.UIComponent getSelectMultipleButton()

Get select multiple button.

Returns:

The select multiple button.

getActionsSeparatorIcon

public javax.faces.component.UIComponent getActionsSeparatorIcon()

Get the actions separator icon.

Returns:

The top actions separator icon.

getFilterSeparatorIcon

public javax.faces.component.UIComponent getFilterSeparatorIcon()

Get the filter separator icon.

Returns:

The filter separator icon.

getPaginateSeparatorIcon

public javax.faces.component.UIComponent getPaginateSeparatorIcon()

Get the paginate separator icon.

Returns:

The paginate separator icon.

getViewActionsSeparatorIcon

public javax.faces.component.UIComponent getViewActionsSeparatorIcon()

Get the view actions separator icon.

Returns:

The view actions separator icon.

getClearSortButton

public javax.faces.component.UIComponent getClearSortButton()

Get clear sort button.

Returns:

The clear sort button.

getFilterLabel

public javax.faces.component.UIComponent getFilterLabel()

Get filter label.

Returns:

The filter label.

getPreferencesPanelToggleButton

public javax.faces.component.UIComponent getPreferencesPanelToggleButton()

Get preferences panel toggle button.

Returns:

The preferences panel toggle button.

getSortPanelToggleButton

public javax.faces.component.UIComponent getSortPanelToggleButton()

Get sort panel toggle button.

Returns:

The sort panel toggle button.

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

If the rendered property is true, render the begining of the current state of this UIComponent to the response contained in the specified FacesContext. If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeBegin(FacesContext, UIComponent).

Parameters:

context - FacesContext for the current request.

Throws:

java.io.IOException - if an input/output error occurs while rendering.

java.lang.NullPointerException - if FacesContext is null.