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

java.lang.Object
  extended byjavax.faces.component.UIComponent
      extended byjavax.faces.component.UIComponentBase
          extended bycom.sun.rave.web.ui.component.TablePanelsBase
              extended bycom.sun.rave.web.ui.component.TablePanels
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class TablePanels
extends TablePanelsBase
implements javax.faces.component.NamingContainer

Component that represents an embedded panel.

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.TablePanels.level = FINE
 


Field Summary
static java.lang.String FILTER_PANEL_ID
          The facet name for the filter panel.
static java.lang.String PREFERENCES_PANEL_ID
          The facet name for the preferences panel.
static java.lang.String PRIMARY_SORT_COLUMN_MENU_FACET
          The facet name for the primary sort column menu.
static java.lang.String PRIMARY_SORT_COLUMN_MENU_ID
          The component id for the primary sort column menu.
static java.lang.String PRIMARY_SORT_COLUMN_MENU_LABEL_FACET
          The facet name for the primary sort column menu label.
static java.lang.String PRIMARY_SORT_COLUMN_MENU_LABEL_ID
          The component id for the primary sort column menu label.
static java.lang.String PRIMARY_SORT_ORDER_MENU_FACET
          The facet name for the primary sort order menu.
static java.lang.String PRIMARY_SORT_ORDER_MENU_ID
          The component id for the primary sort order menu.
static java.lang.String SECONDARY_SORT_COLUMN_MENU_FACET
          The facet name for the secondary sort column menu.
static java.lang.String SECONDARY_SORT_COLUMN_MENU_ID
          The component id for the secondary sort column menu.
static java.lang.String SECONDARY_SORT_COLUMN_MENU_LABEL_FACET
          The facet name for the secondary sort column menu label.
static java.lang.String SECONDARY_SORT_COLUMN_MENU_LABEL_ID
          The component id for the secondary sort column menu label.
static java.lang.String SECONDARY_SORT_ORDER_MENU_FACET
          The facet name for the secondary sort order menu.
static java.lang.String SECONDARY_SORT_ORDER_MENU_ID
          The component id for the secondary sort order menu.
static java.lang.String SORT_PANEL_CANCEL_BUTTON_FACET
          The facet name for the sort panel cancel button.
static java.lang.String SORT_PANEL_CANCEL_BUTTON_ID
          The component id for the sort panel cancel button.
static java.lang.String SORT_PANEL_ID
          The facet name for the sort panel.
static java.lang.String SORT_PANEL_SUBMIT_BUTTON_FACET
          The facet name for the sort panel submit button.
static java.lang.String SORT_PANEL_SUBMIT_BUTTON_ID
          The component id for the sort panel submit button.
static java.lang.String TERTIARY_SORT_COLUMN_MENU_FACET
          The facet name for the tertiary sort column menu.
static java.lang.String TERTIARY_SORT_COLUMN_MENU_ID
          The component id for the tertiary sort column menu.
static java.lang.String TERTIARY_SORT_COLUMN_MENU_LABEL_FACET
          The facet name for the tertiary sort column menu label.
static java.lang.String TERTIARY_SORT_COLUMN_MENU_LABEL_ID
          The component id for the tertiary sort column menu label.
static java.lang.String TERTIARY_SORT_ORDER_MENU_FACET
          The facet name for the tertiary sort order menu.
static java.lang.String TERTIARY_SORT_ORDER_MENU_ID
          The component id for the tertiary sort order menu.
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
TablePanels()
          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 getPrimarySortColumnMenu()
          Get primary sort column menu used in the sort panel.
 javax.faces.component.UIComponent getPrimarySortColumnMenuLabel()
          Get primary sort column menu label used in the sort panel.
 javax.faces.component.UIComponent getPrimarySortOrderMenu()
          Get primary sort order menu used in the sort panel.
 javax.faces.component.UIComponent getSecondarySortColumnMenu()
          Get secondary sort column menu used in the sort panel.
 javax.faces.component.UIComponent getSecondarySortColumnMenuLabel()
          Get secondary sort column menu label used in the sort panel.
 javax.faces.component.UIComponent getSecondarySortOrderMenu()
          Get secondary sort order menu used in the sort panel.
 javax.faces.component.UIComponent getSortPanelCancelButton()
          Get sort panel cancel button.
 javax.faces.component.UIComponent getSortPanelSubmitButton()
          Get sort panel submit button.
 Table getTableAncestor()
          Get the closest Table ancestor that encloses this component.
 javax.faces.component.UIComponent getTertiarySortColumnMenu()
          Get tertiary sort column menu used in the sort panel.
 javax.faces.component.UIComponent getTertiarySortColumnMenuLabel()
          Get tertiary sort column menu label used in the sort panel.
 javax.faces.component.UIComponent getTertiarySortOrderMenu()
          Get tertiary sort order menu used in the sort panel.
 
Methods inherited from class com.sun.rave.web.ui.component.TablePanelsBase
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, isFilterPanel, isNoWrap, isPreferencesPanel, isVisible, restoreState, saveState, setAbbr, setAlign, setAxis, setBgColor, setChar, setCharOff, setColSpan, setExtraHtml, setFilterPanel, setHeaders, setHeight, setNoWrap, setOnClick, setOnDblClick, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setPreferencesPanel, 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

FILTER_PANEL_ID

public static final java.lang.String FILTER_PANEL_ID
The facet name for the filter panel.

See Also:
Constant Field Values

PREFERENCES_PANEL_ID

public static final java.lang.String PREFERENCES_PANEL_ID
The facet name for the preferences panel.

See Also:
Constant Field Values

PRIMARY_SORT_COLUMN_MENU_ID

public static final java.lang.String PRIMARY_SORT_COLUMN_MENU_ID
The component id for the primary sort column menu.

See Also:
Constant Field Values

PRIMARY_SORT_COLUMN_MENU_FACET

public static final java.lang.String PRIMARY_SORT_COLUMN_MENU_FACET
The facet name for the primary sort column menu.

See Also:
Constant Field Values

PRIMARY_SORT_COLUMN_MENU_LABEL_ID

public static final java.lang.String PRIMARY_SORT_COLUMN_MENU_LABEL_ID
The component id for the primary sort column menu label.

See Also:
Constant Field Values

PRIMARY_SORT_COLUMN_MENU_LABEL_FACET

public static final java.lang.String PRIMARY_SORT_COLUMN_MENU_LABEL_FACET
The facet name for the primary sort column menu label.

See Also:
Constant Field Values

PRIMARY_SORT_ORDER_MENU_ID

public static final java.lang.String PRIMARY_SORT_ORDER_MENU_ID
The component id for the primary sort order menu.

See Also:
Constant Field Values

PRIMARY_SORT_ORDER_MENU_FACET

public static final java.lang.String PRIMARY_SORT_ORDER_MENU_FACET
The facet name for the primary sort order menu.

See Also:
Constant Field Values

SECONDARY_SORT_COLUMN_MENU_ID

public static final java.lang.String SECONDARY_SORT_COLUMN_MENU_ID
The component id for the secondary sort column menu.

See Also:
Constant Field Values

SECONDARY_SORT_COLUMN_MENU_FACET

public static final java.lang.String SECONDARY_SORT_COLUMN_MENU_FACET
The facet name for the secondary sort column menu.

See Also:
Constant Field Values

SECONDARY_SORT_COLUMN_MENU_LABEL_ID

public static final java.lang.String SECONDARY_SORT_COLUMN_MENU_LABEL_ID
The component id for the secondary sort column menu label.

See Also:
Constant Field Values

SECONDARY_SORT_COLUMN_MENU_LABEL_FACET

public static final java.lang.String SECONDARY_SORT_COLUMN_MENU_LABEL_FACET
The facet name for the secondary sort column menu label.

See Also:
Constant Field Values

SECONDARY_SORT_ORDER_MENU_ID

public static final java.lang.String SECONDARY_SORT_ORDER_MENU_ID
The component id for the secondary sort order menu.

See Also:
Constant Field Values

SECONDARY_SORT_ORDER_MENU_FACET

public static final java.lang.String SECONDARY_SORT_ORDER_MENU_FACET
The facet name for the secondary sort order menu.

See Also:
Constant Field Values

SORT_PANEL_ID

public static final java.lang.String SORT_PANEL_ID
The facet name for the sort panel.

See Also:
Constant Field Values

SORT_PANEL_CANCEL_BUTTON_ID

public static final java.lang.String SORT_PANEL_CANCEL_BUTTON_ID
The component id for the sort panel cancel button.

See Also:
Constant Field Values

SORT_PANEL_CANCEL_BUTTON_FACET

public static final java.lang.String SORT_PANEL_CANCEL_BUTTON_FACET
The facet name for the sort panel cancel button.

See Also:
Constant Field Values

SORT_PANEL_SUBMIT_BUTTON_ID

public static final java.lang.String SORT_PANEL_SUBMIT_BUTTON_ID
The component id for the sort panel submit button.

See Also:
Constant Field Values

SORT_PANEL_SUBMIT_BUTTON_FACET

public static final java.lang.String SORT_PANEL_SUBMIT_BUTTON_FACET
The facet name for the sort panel submit button.

See Also:
Constant Field Values

TERTIARY_SORT_COLUMN_MENU_ID

public static final java.lang.String TERTIARY_SORT_COLUMN_MENU_ID
The component id for the tertiary sort column menu.

See Also:
Constant Field Values

TERTIARY_SORT_COLUMN_MENU_FACET

public static final java.lang.String TERTIARY_SORT_COLUMN_MENU_FACET
The facet name for the tertiary sort column menu.

See Also:
Constant Field Values

TERTIARY_SORT_COLUMN_MENU_LABEL_ID

public static final java.lang.String TERTIARY_SORT_COLUMN_MENU_LABEL_ID
The component id for the tertiary sort column menu label.

See Also:
Constant Field Values

TERTIARY_SORT_COLUMN_MENU_LABEL_FACET

public static final java.lang.String TERTIARY_SORT_COLUMN_MENU_LABEL_FACET
The facet name for the tertiary sort column menu label.

See Also:
Constant Field Values

TERTIARY_SORT_ORDER_MENU_ID

public static final java.lang.String TERTIARY_SORT_ORDER_MENU_ID
The component id for the tertiary sort order menu.

See Also:
Constant Field Values

TERTIARY_SORT_ORDER_MENU_FACET

public static final java.lang.String TERTIARY_SORT_ORDER_MENU_FACET
The facet name for the tertiary sort order menu.

See Also:
Constant Field Values
Constructor Detail

TablePanels

public TablePanels()
Default constructor

Method Detail

getTableAncestor

public Table getTableAncestor()
Get the closest Table ancestor that encloses this component.

Returns:
The Table ancestor.

getPrimarySortColumnMenu

public javax.faces.component.UIComponent getPrimarySortColumnMenu()
Get primary sort column menu used in the sort panel.

Returns:
The primary sort column menu.

getPrimarySortColumnMenuLabel

public javax.faces.component.UIComponent getPrimarySortColumnMenuLabel()
Get primary sort column menu label used in the sort panel.

Returns:
The primary sort column menu label.

getPrimarySortOrderMenu

public javax.faces.component.UIComponent getPrimarySortOrderMenu()
Get primary sort order menu used in the sort panel.

Returns:
The primary sort order menu.

getSecondarySortColumnMenu

public javax.faces.component.UIComponent getSecondarySortColumnMenu()
Get secondary sort column menu used in the sort panel.

Returns:
The secondary sort column menu.

getSecondarySortColumnMenuLabel

public javax.faces.component.UIComponent getSecondarySortColumnMenuLabel()
Get secondary sort column menu label used in the sort panel.

Returns:
The secondary sort column menu label.

getSecondarySortOrderMenu

public javax.faces.component.UIComponent getSecondarySortOrderMenu()
Get secondary sort order menu used in the sort panel.

Returns:
The secondary sort order menu.

getSortPanelCancelButton

public javax.faces.component.UIComponent getSortPanelCancelButton()
Get sort panel cancel button.

Returns:
The sort panel cancel button.

getSortPanelSubmitButton

public javax.faces.component.UIComponent getSortPanelSubmitButton()
Get sort panel submit button.

Returns:
The sort panel submit button.

getTertiarySortColumnMenu

public javax.faces.component.UIComponent getTertiarySortColumnMenu()
Get tertiary sort column menu used in the sort panel.

Returns:
The tertiary sort column menu.

getTertiarySortColumnMenuLabel

public javax.faces.component.UIComponent getTertiarySortColumnMenuLabel()
Get tertiary sort column menu label used in the sort panel.

Returns:
The tertiary sort column menu label.

getTertiarySortOrderMenu

public javax.faces.component.UIComponent getTertiarySortOrderMenu()
Get tertiary sort order menu used in the sort panel.

Returns:
The tertiary sort order menu.

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.