UIPivotTable (Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components)

java.lang.Object
- javax.faces.component.UIComponent
- - org.apache.myfaces.trinidad.component.UIXComponent
  - - org.apache.myfaces.trinidad.component.UIXComponentBase
    - - oracle.adf.view.faces.bi.component.pivotTable.UIGrid
      - oracle.adf.view.faces.bi.component.pivotTable.UIPivotTable

All Implemented Interfaces:: java.util.EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UIPivotTable
extends UIGrid
implements javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder

The Pivot Table supports the display of multiple nested attributes on a row and column header. In addition, the Pivot Table supports the ability to dynamically change the layout of the attributes displayed in the row or column headers via drag and drop pivoting.

Pivot Table Features

Pivot Table Model

The Pivot Table component uses a model to display and interact with data. The specific model class to use is oracle.adf.view.faces.bi.model.pivotTable.PivotTableModel. In order to link a Pivot Table and a Graph to the same set of data, the model class oracle.adf.view.faces.bi.model.DataModel should be used.

Sizing

The inlineStyle attribute can be used to specify a Pivot Table's width and height. For example, inlineStyle="width:600px;height:400px".

Pivot Table supports auto-sizing, which can be used by setting pivot table's attribute sizing="auto". When auto-sizing is set, the height of the pivot table is determined by the size of the content that is being displayed by the pivot table. If the content is smaller than the default size of the pivot table, then the pivot table will shrink. If the content is larger than the default size of the pivot table, the content will grow and pivot table will display scrollbars as needed.
Please note that when sizing="auto", the pivot table's frame will initially be displayed with the default size of the pivot table ( using the width/height CSS attributes ) and then the pivot table's frame will readjust to fit its contents. This can cause the layout of the page displaying the pivot table to change after the page is initially displayed.

Customizing Cell Content

In order to customize header cell content, use HeaderFormat attributes. For customizing data cell content, use DataFormat attributes. HeaderFormat/DataFormat attributes return instances of oracle.dss.adf.view.faces.bi.component.pivotTable.CellFormat. CellFormat instances allow specification of the following:

a converter, javax.faces.convert.Converter, which is used to perform number/date/text formatting of a cell raw value
a CSS style, which is used to change the CSS style of a cell
a CSS text style, which is used to change the CSS style of a cell's text
a new raw value, which is used to change the cell's underlying value that was returned from the data model

For more detailed description, refer to <dvt:dataCell> component guide

Selection

Selection allows a user to select one or more cells. Pivot table has three different types of selection, i.e. row header selection set, column header selection set, and data selection set. Only one type of selection can be made in pivot table at any one time. An application can implement some features, for example, display a customized content for a context menu, based on the current selected cells. The application must PPR the Pivot Table after programmatically setting or mutating the Selection.

The code example below shows how to get the currently selected header cells.

     
          UIPivotTable pt = getPivotTable();
          if (pt == null)
              return null;
          HeaderCellSelectionSet headerCells = null;
          if (pt.getSelection().getColumnHeaderCells().size() > 0) {
                headerCells = pt.getSelection().getColumnHeaderCells();
          } else if (pt.getSelection().getRowHeaderCells().size() > 0) {
                headerCells = pt.getSelection().getRowHeaderCells();
          }

Drill

Drill operation is used to hide or unhide hierarchy of the data within pivot table. It is supported when the underlying data source allows this operation. A drill listener will be notified after a drill event is successfully performed. drillEnabled attribute specifies whether drilling is enabled.

Pivot

Pivot operation can be peformed for each data attribute, and it will change the data presentation structure within pivot table. It is supported when the underlying data source allows this operation. A pivot listener will be notified after a pivot event is successfully performed. This operation can be enabled using pivotEnabled property of pivot table.

Sort

The sort operation is used to sort data or header cells within the pivot table. It is supported when the underlying data source allows this operation. A sort listener will be notified after a sort is successfully performed. The sortMode attribute specifies if the data sort operation is enabled, and which type of sort should be used. The headerSortMode attribute specifies if the header sort operation is enabled.

Split Panes

The Split Panes feature allows the Pivot Table to be split into multiple panes vertically and/or horizontally. This facilitates side-by-side viewing of rows or columns that are not located next to each other. A split listener will be notified after a split is successfully added to or removed from the Pivot Table. The splitMode attribute specifies whether the Split Panes feature is enabled.

Status Bar

Pivot Table provides status bar that will be shown when pivot table's attribute statusBarRendered="true". It provides selection information, i.e. current selection type and number of cells/rows/columns selected.

Geometry Management

This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout, panelSplitter
This component is automatically stretched to fill up the browser's viewport when it is the "sole visual root component" in the component tree and if the document component is configured with maximized="true" (the default).
When NOT stretched, this component will be displayed in its default dimensions which are provided by the skin. This can be modified by applying a dimension using the inlineStyle or styleClass attributes.
This component does not stretch its children. Specifically, the content of the header cell and data cell will not be stretched. The dimension of the header cell and data cell is determined either by the stamped component inside the header and data cell, or by the sizingManager. Please refer to sizingManager attribute for more information.
See also the sizing attribute.

Accessibility Guideline(s)

summary attribute:The summary property must be specified. The summary should describe the purpose of the component.

Supported Client Events for Client Behaviors

blur
click (default)
contextMenu
dblClick
focus

keyDown
keyPress
keyUp
mouseDown
mouseMove

mouseOut
mouseOver
mouseUp
propertyChange

Child Tags

This component can be the parent of:

<dvt:headerCell> is used to specify non-editable value holder for each header attribute
<dvt:dataCell> is used to specify non-editable as well as editable component type for each data attribute

Example

The following shows an example of using Pivot Table component

     
         <dvt:pivotTable id="goodPT"    
                            value="#{pivotTableEditBean.dataModel}" />

The following shows an example of specifying listeners for various pivot table operations

         <dvt:pivotTable id="goodPT"
                            value="#{richPivotTableModel.dataModel}"
                            pivotListener="#{richPivotTableBean.handlePivotEvent}"
                            drillRequestedListener="#{richPivotTableBean.handleDrillRequestedEvent}"
                            sortListener="#{richPivotTableBean.handleSortEvent}"
                            />

Since:: release specific (what release of product did this appear in)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UIPivotTable.ActionType`
`static class`	`UIPivotTable.DataCellContent` Internal use only.
`protected class`	`UIPivotTable.DataCellHeaderCellsMap` For use in EL.
`protected class`	`UIPivotTable.EdgeLayerIndex` For use by EL code.
`protected class`	`UIPivotTable.HeaderCellMetadata` For use in EL.
`protected class`	`UIPivotTable.LayersMap` For use by EL code.

Nested classes/interfaces inherited from class oracle.adf.view.faces.bi.component.pivotTable.UIGrid
UIGrid.DefaultClientKeyManager, UIGrid.NullCellKey

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields
Modifier and Type	Field and Description
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`ACTIVE_CELL_KEY_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`AUTOINDENT_KEY`
`static java.lang.String`	`BODY_CONTEXT_MENU_FACET`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`BODY_CONTEXT_MENU_ID_KEY` Deprecated. Use the `bodyContextMenu` facet instead.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`CELL_IMAGE_CLICK_ACTION_KEY` Deprecated. Use `<dvt:dataCell>` with child tag `<af:image>` or `<af:commandImageLink>` instead.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`CELL_IMAGE_CLICK_LISTENER_KEY` Deprecated. Use `<dvt:dataCell>` with child tag `<af:image>` or `<af:commandImageLink>` instead.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`CLIENT_LISTENERS_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`COLUMN_FETCH_SIZE_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`COLUMN_HEADER_START_LAYER_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`COLUMN_HEADER_START_PIXEL_KEY` For internal use only.
`static java.lang.String`	`COMPONENT_FAMILY`
`static java.lang.String`	`COMPONENT_TYPE`
`static java.lang.String`	`CONTENT_DELIVERY_IMMEDIATE`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`CONTENT_DELIVERY_KEY`
`static java.lang.String`	`CONTENT_DELIVERY_LAZY`
`static java.lang.String`	`CONTENT_DELIVERY_WHEN_AVAILABLE`
`static java.lang.String`	`CONTEXT_MENU_FACET`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`CONTEXT_MENU_ID_KEY` Deprecated. Use the `contextMenu` facet instead.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`CUSTOMIZATION_ID_KEY` Deprecated. This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DATA_CELL_CONTENT_KEY` For internal use only.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DATA_FORMAT_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DATA_FORMAT_MANAGER_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DEFAULT_GRAPH_KEY` For internal use only.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DONT_PERSIST_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DRILL_ACTION_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DRILL_REQUESTED_LISTENER_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DRILL_REQUESTING_LISTENER_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DRILLING_ENABLED_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`EMPTY_TEXT_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`GRAPH_SCREENREADER_MODE` For internal use only.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`HEADER_FORMAT_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`HEADER_FORMAT_MANAGER_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`HEADER_SORT_MODE_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`INDENT_ENABLED_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`INLINE_STYLE_KEY`
`static java.lang.String`	`LAYER_LABEL_MODE_HIDDEN`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`LAYER_LABEL_MODE_KEY`
`static java.lang.String`	`LAYER_LABEL_MODE_RENDERED`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`MODEL_NAME_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`PARTIAL_TRIGGERS_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`PERSIST_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`PIVOT_ENABLED_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`PIVOT_LABEL_VISIBLE_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`PIVOT_LISTENER_KEY`
`static java.lang.String`	`PIVOTTABLE_NAME` For internal use only.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`PREFERRED_COLUMN_HEADER_HEIGHT_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`PREFERRED_ROW_HEADER_WIDTH_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`ROW_FETCH_SIZE_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`ROW_HEADER_START_LAYER_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`ROW_HEADER_START_PIXEL_KEY` For internal use only.
`static java.lang.String`	`SCROLL_POLICY_AUTO`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SCROLL_POLICY_KEY`
`static java.lang.String`	`SCROLL_POLICY_PAGE`
`static java.lang.String`	`SCROLL_POLICY_SCROLL`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SECOND_START_COLUMN_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SECOND_START_COLUMN_PIXEL_KEY` For internal use only.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SECOND_START_ROW_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SECOND_START_ROW_PIXEL_KEY` For internal use only.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SELECTION_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SHRINK_TO_FIT_KEY` For internal use only.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SIZING_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SIZING_MANAGER_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SORT_LISTENER_KEY`
`static java.lang.String`	`SORT_MODE_GROUPED`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SORT_MODE_KEY`
`static java.lang.String`	`SORT_MODE_NONE`
`static java.lang.String`	`SORT_MODE_UNGROUPED`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SPLIT_COLUMN_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SPLIT_LISTENER_KEY`
`static java.lang.String`	`SPLIT_MODE_DISABLED`
`static java.lang.String`	`SPLIT_MODE_ENABLED`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SPLIT_MODE_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SPLIT_ROW_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`START_COLUMN_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`START_COLUMN_PIXEL_KEY` For internal use only.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`START_ROW_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`START_ROW_PIXEL_KEY` For internal use only.
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`STATUS_BAR_RENDERED_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`STYLE_CLASS_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SUMMARY_KEY`
`static org.apache.myfaces.trinidad.bean.FacesBean.Type`	`TYPE`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`VALUE_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`VAR_STATUS_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`VISIBLE_KEY`

Fields inherited from class oracle.adf.view.faces.bi.component.pivotTable.UIGrid
VAR_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR

Constructor Summary

Constructors
Constructor and Description

UIPivotTable()
Constructs a new Pivot Table.

Constructors
Constructor and Description
`UIPivotTable()` Constructs a new Pivot Table.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addActionListener(javax.faces.event.ActionListener listener)` Do not use this method to add any ActionListeners.
`void`	`addCellImageClickListener(CellImageClickListener listener)` Deprecated. Use `<dvt:dataCell>` with child tag `<af:image>` or `<af:commandImageLink>` instead.
`void`	`addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)` Gets the client behaviors for this component.
`void`	`addDrillListener(DrillListener listener)` Adds a drill listener.
`void`	`addPivotListener(PivotListener listener)` Adds a pivot listener.
`void`	`addSortListener(SortListener listener)` Adds a sort listener.
`void`	`addSplitListener(SplitListener listener)` Adds a split listener.
`void`	`broadcast(javax.faces.event.FacesEvent event)` Delivers a wrapped event to the appropriate component.
`void`	`cleanClientKeyManager()` For internal use only.
`void`	`cleanStampState()` For internal use only.
`DataModel`	`createDataModel(DataModel current, java.lang.Object value)` Creates the pivot table's data model, as an instance of `DataModel`.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`createVarStatusMap()` Creates the map that backs the "varStatus" EL functionality.
`protected boolean`	`defaultVisitChildren(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)`
`protected void`	`drill(DrillEvent drillEvent)` Performs a drill on the Pivot Table.
`protected void`	`fireEventToAppListener(javax.faces.context.FacesContext context, javax.faces.event.FacesEvent event)` Fires the specified event to the default action listener.
`javax.faces.el.MethodBinding`	`getAction()` For internal use only.
`javax.el.MethodExpression`	`getActionExpression()` For internal use only.
`javax.faces.el.MethodBinding`	`getActionListener()` For internal use only.
`javax.faces.event.ActionListener[]`	`getActionListeners()` For internal use only.
`UIPivotTable.ActionType`	`getActionType()` Gets the action type.
`CellKey`	`getActiveCellKey()` Retrieves the active cell key of the Pivot Table.
`int`	`getAutoIndent()` Retrieves the number of pixels that row labels of different levels are indented.
`protected org.apache.myfaces.trinidad.bean.FacesBean.Type`	`getBeanType()` Gets the bean type.
`java.lang.String`	`getBodyContextMenuId()` Deprecated. Use the `bodyContextMenu` facet instead.
`javax.faces.component.UIComponent`	`getCellComponent()` Gets the stamped component for the current cell.
`CellFormat`	`getCellFormat()` Gets the `CellFormat` for the current cell.
`javax.el.MethodExpression`	`getCellImageClickAction()` Deprecated. Use `<dvt:dataCell>` with child tag `<af:image>` or `<af:commandImageLink>` instead.
`javax.el.MethodExpression`	`getCellImageClickListener()` Deprecated. Use `<dvt:dataCell>` with child tag `<af:image>` or `<af:commandImageLink>` instead.
`CellImageClickListener[]`	`getCellImageClickListeners()` Deprecated. Use `<dvt:dataCell>` with child tag `<af:image>` or `<af:commandImageLink>` instead.
`java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>>`	`getClientBehaviors()` Gets the client behaviors for this component.
`java.util.List<DataBlock>`	`getClientBlocks()` For internal use only.
`oracle.adf.view.rich.event.ClientListenerSet`	`getClientListeners()` Gets a set of client listeners.
`int`	`getColumnFetchSize()` Retrieves the number of columns to fetch in each pivot table block that is downloaded to the user agent / browser.
`int`	`getColumnHeaderStartLayer()` Retrieves the index of the first layer (row of header labels) displayed in the column header.
`java.lang.String`	`getContentDelivery()` Retrieves whether the content of the pivot table is delivered immediately or lazily.
`java.lang.String`	`getContextMenuId()` Deprecated. Use the `contextMenu` facet instead.
`java.lang.Object`	`getCurrentCellContext()` For internal use only.
`java.lang.String`	`getCustomizationId()` Deprecated. The `id` attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
`protected UIDataCell`	`getDataCell(java.lang.String dataAttribute)` Gets the `UIDataCell` for this Pivot Table.
`protected CellFormat`	`getDataCellFormat(javax.faces.context.FacesContext context, javax.el.MethodExpression dataFormat, DataFormatManager dataFormatManager, DataModel model, int row, int column, QDR qdr, java.lang.Object value)` Gets the `CellFormat` for the data cell indicated by the parameters.
`javax.el.MethodExpression`	`getDataFormat()` Retrieves the pivot table's data cell `CellFormat` `MethodExpression`.
`DataFormatManager`	`getDataFormatManager()` Retrieves the pivot table's `DataFormatManager`.
`java.lang.String`	`getDefaultEventName()` Gets the default event name.
`java.lang.String[]`	`getDontPersist()` Gets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
`javax.el.MethodExpression`	`getDrillAction()` Gets the drill action.
`DrillListener[]`	`getDrillListeners()` Gets the drill listeners.
`javax.el.MethodExpression`	`getDrillRequestedListener()` Gets the "after drill" listener.
`javax.el.MethodExpression`	`getDrillRequestingListener()` Gets the "before drill" listener.
`java.lang.String`	`getEmptyText()` Retrieves the text shown in an empty pivot table, that is, a pivot table having 0 rows or columns.
`java.util.Collection<java.lang.String>`	`getEventNames()` Gets the names of all the events supported by this component.
`java.lang.String`	`getFamily()` Returns the identifier of the component family to which this component belongs.
`protected UIHeaderCell`	`getHeaderCell()` Gets the `UIHeaderCell` for this Pivot Table.
`protected CellFormat`	`getHeaderCellFormat(javax.faces.context.FacesContext context, javax.el.MethodExpression headerFormat, HeaderFormatManager headerFormatManager, DataModel model, int edge, int layer, int slice, QDR qdr, java.lang.Object value)` Gets the `CellFormat` for the header cell indicated by the parameters.
`javax.el.MethodExpression`	`getHeaderFormat()` Retrieves the pivot table's header cell `CellFormat` `MethodExpression`.
`HeaderFormatManager`	`getHeaderFormatManager()` Retrieves the pivot table's `HeaderFormatManager`.
`java.lang.String`	`getHeaderSortMode()` Retrieves the header sort mode.
`java.lang.String`	`getInlineStyle()` Retrieves the pivot table's outer element's inline style, which can be used for sizing/positioning the pivot table.
`java.lang.String`	`getLayerLabelMode()` Indicates whether layer/dimension labels appear above each row header layer and beside each column header layer.
`java.lang.Object`	`getLocalValue()` Application developers should not call this method.
`protected java.lang.String`	`getMeasureName(QDR qdr)` Gets the name of the measure dimension of the specified `QDR`.
`java.lang.String`	`getModelName()` Retrieves the model name of the Pivot Table.
`java.lang.String[]`	`getPartialTriggers()` Gets the partial triggers of this component.
`java.lang.String[]`	`getPersist()` Gets a list of persistent attributes that are persisted to a registered "Persistent Change Manager".
`javax.el.MethodExpression`	`getPivotListener()` Gets the pivot listener.
`PivotListener[]`	`getPivotListeners()` Gets the pivot listeners.
`java.lang.String`	`getPreferredColumnHeaderHeight()` Retrieves the preferred height of the column header, as a percentage of the total available height of the Pivot Table.
`java.lang.String`	`getPreferredRowHeaderWidth()` Retrieves the preferred width of the row header, as a percentage of the total available width of the Pivot Table.
`java.lang.Object`	`getRawValue()` Gets the raw value of the current cell.
`int`	`getRowFetchSize()` Retrieves the number of rows to fetch in each pivot table block that is downloaded to the user agent / browser.
`int`	`getRowHeaderStartLayer()` Retrieves the index of the first layer (column of header labels) displayed in the row header.
`java.lang.String`	`getScrollPolicy()` Gets the mechanism used to scroll data within the Pivot Table.
`int`	`getSecondStartColumn()` If panes are split so that there is both a left and right databody pane, retrieves the index of the first column to be scrolled into view in the second pane.
`int`	`getSecondStartRow()` If panes are split so that there is both a top and bottom databody pane, retrieves the index of the first row to be scrolled into view in the bottom pane.
`Selection`	`getSelection()` Retrieves the `Selection` instance that indicates which data cells and header cells are selected in the pivot table.
`java.lang.String`	`getSizing()` Retrieves how the pivot table's size ( width/height ) is determined.
`SizingManager`	`getSizingManager()` Retrieves the `SizingManager` instance that controls overrides for row heights, column widths, row header column widths, and column header row heights.
`javax.el.MethodExpression`	`getSortListener()` Gets the sort listener.
`SortListener[]`	`getSortListeners()` Gets the sort listeners.
`java.lang.String`	`getSortMode()` Retrieves the sort mode.
`int`	`getSplitColumn()` Sets the splitColumn attribute.
`javax.el.MethodExpression`	`getSplitListener()` Gets the split listener.
`SplitListener[]`	`getSplitListeners()` Gets the split listeners.
`java.lang.String`	`getSplitMode()` Retrieves the split mode, which controls whether the split-panes feature is enabled.
`int`	`getSplitRow()` Gets the `splitRow` attribute.
`java.util.List<javax.faces.component.UIComponent>`	`getStamps()` Gets the UIComponents that are considered stamps.
`protected java.util.List<javax.faces.component.UIComponent>`	`getStamps(UIDataCell dataCell)` Returns the component(s) stamped into the data cell.
`protected java.util.List<javax.faces.component.UIComponent>`	`getStamps(UIHeaderCell headerCell)` Returns the component(s) stamped into the header cell.
`int`	`getStartColumn()` Retrieves the index of the first column that is scrolled into view in this pivot table.
`int`	`getStartRow()` Retrieves the index of the first row that is scrolled into view in this pivot table.
`java.lang.String`	`getStyleClass()` Retrieves the CSS style class to use for this component.
`java.lang.String`	`getSummary()` Retrieves a summary of this pivot table's purpose and structure for user agents rendering to non-visual media / screen readers.
`java.lang.Object`	`getValue()` Retrieves the pivot table's data model, which should be an instance of `DataModel`.
`java.lang.String`	`getVarStatus()` Gets Name of the EL variable used to reference the `varStatus` information.
`boolean`	`isDrillingEnabled()` Retrieves whether drilling is enabled.
`boolean`	`isImmediate()` Returns `false`.
`boolean`	`isIndentEnabled()` Indicates whether row labels are indented.
`boolean`	`isPivotEnabled()` Indicates whether pivoting is enabled.
`boolean`	`isPivotLabelVisible()` Indicates whether layer/dimension names appear on pivot handles.
`boolean`	`isStatusBarRendered()` Retrieves a `boolean` indicating whether the status bar is rendered in the pivot table.
`boolean`	`isVisible()` Retrieves the visibility of the component.
`protected void`	`postCellDataChange()` Sets up this component to use the new cellData.
`protected void`	`processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)` Process this component's facets and children.
`void`	`queueEvent(javax.faces.event.FacesEvent e)` Queues the specified event.
`void`	`removeActionListener(javax.faces.event.ActionListener listener)` Do not use this method to remove any ActionListeners.
`void`	`removeCellImageClickListener(CellImageClickListener listener)` Deprecated. Use `<dvt:dataCell>` with child tag `<af:image>` or `<af:commandImageLink>` instead.
`void`	`removeDrillListener(DrillListener listener)` Removes the specified drill listener.
`void`	`removePivotListener(PivotListener listener)` Removes the specified pivot listener.
`void`	`removeSortListener(SortListener listener)` Removes the specified sort listener.
`void`	`removeSplitListener(SplitListener listener)` Removes the specified split listener.
`protected void`	`resetStamps()` Currently this method is not used.
`void`	`setAction(javax.faces.el.MethodBinding action)` For internal use only.
`void`	`setActionExpression(javax.el.MethodExpression action)` For internal use only.
`void`	`setActionListener(javax.faces.el.MethodBinding listener)` Do not use this method to set any ActionListeners.
`void`	`setActionType(UIPivotTable.ActionType actionType)` Sets the action type.
`void`	`setActiveCellKey(CellKey activeCellKey)` Specifies the active cell key of the Pivot Table.
`void`	`setAutoIndent(int i)` Specifies how much to indent row labels for each level in a hierarchy.
`void`	`setBodyContextMenuId(java.lang.String bodyContextMenuId)` Deprecated. Use the `bodyContextMenu` facet instead.
`void`	`setCellImageClickAction(javax.el.MethodExpression cellImageClickAction)` Deprecated. Use `<dvt:dataCell>` with child tag `<af:image>` or `<af:commandImageLink>` instead.
`void`	`setCellImageClickListener(javax.el.MethodExpression cellImageClickListener)` Deprecated. Use `<dvt:dataCell>` with child tag `<af:image>` or `<af:commandImageLink>` instead.
`void`	`setClientBlocks(java.util.List<DataBlock> clientBlocks)` For internal use only.
`void`	`setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)` Sets a set of client listeners.
`void`	`setColumnFetchSize(int columnFetchSize)` Specifies the number of columns to fetch in each pivot table block that is downloaded to the user agent / browser.
`void`	`setColumnHeaderStartLayer(int layer)` Specifies the first layer (row of header labels) to display in the column header.
`void`	`setContentDelivery(java.lang.String contentDelivery)` Specifies whether the content of the pivot table is delivered immediately or lazily.
`void`	`setContextMenuId(java.lang.String contextMenuId)` Deprecated. Use the `contextMenu` facet instead.
`void`	`setCustomizationId(java.lang.String customizationId)` Deprecated. The `id` attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
`void`	`setDataFormat(javax.el.MethodExpression dataFormat)` Specifies the pivot table's data cell `CellFormat` `MethodExpression`.
`void`	`setDataFormatManager(DataFormatManager dataFormatManager)` Specifies the pivot table's `DataFormatManager`.
`void`	`setDontPersist(java.lang.String[] dontPersist)` Sets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
`void`	`setDrillAction(javax.el.MethodExpression drillAction)` Sets the drill action.
`void`	`setDrillingEnabled(boolean b)` Specifies whether drilling is enabled.
`void`	`setDrillRequestedListener(javax.el.MethodExpression drillRequestedListener)` Sets the "after drill" listener
`void`	`setDrillRequestingListener(javax.el.MethodExpression drillRequestingListener)` Sets the "before drill" listener
`void`	`setEmptyText(java.lang.String emptyText)` Sets the text shown in an empty pivot table, that is, a pivot table having 0 rows or columns.
`void`	`setHeaderFormat(javax.el.MethodExpression headerFormat)` Specifies the pivot table's header cell `CellFormat` `MethodExpression`.
`void`	`setHeaderFormatManager(HeaderFormatManager headerFormatManager)` Specifies the pivot table's `HeaderFormatManager`.
`void`	`setHeaderSortMode(java.lang.String headerSortMode)` Specifies the header sort mode.
`void`	`setImmediate(boolean immediate)` This method does nothing.
`void`	`setIndentEnabled(boolean b)` Specifies whether to indent the labels in the row header.
`void`	`setInlineStyle(java.lang.String inlineStyle)` Specifies the pivot table's outer element's inline style, which can be used for sizing/positioning the pivot table.
`void`	`setLayerLabelMode(java.lang.String layerLabelMode)` Specifies whether layer/dimension labels appear above each row header layer and beside each column header layer.
`void`	`setModelName(java.lang.String modelName)` Specifies the model name of the Pivot Table.
`void`	`setPartialTriggers(java.lang.String[] ids)` Sets partial triggers on this component.
`void`	`setPersist(java.lang.String[] persist)` Sets a list of persistent attributes that are persisted to a registered "Persistent Change Manager".
`void`	`setPivotEnabled(boolean enabled)` Specifies whether pivoting is enabled.
`void`	`setPivotLabelVisible(boolean visible)` Specifies whether the names of layers/dimensions appear on pivot handles.
`void`	`setPivotListener(javax.el.MethodExpression pivotListener)` Sets the pivot listener.
`void`	`setPreferredColumnHeaderHeight(java.lang.String preferredHeight)` Sets the preferred height of the column header, as a percentage of the total available height of the Pivot Table.
`void`	`setPreferredRowHeaderWidth(java.lang.String preferredWidth)` Sets the preferred width of the row header, as a percentage of the total available width of the Pivot Table.
`void`	`setRowFetchSize(int rowFetchSize)` Specifies the number of rows to fetch in each pivot table block that is downloaded to the user agent / browser.
`void`	`setRowHeaderStartLayer(int layer)` Specifies the first layer (column of header labels) to display in the row header.
`void`	`setScrollPolicy(java.lang.String scrollPolicy)` Sets the mechanism used to scroll data within the Pivot Table.
`void`	`setSecondStartColumn(int c)` If panes are split so that there is both a left and right databody pane, specifies the first column to be scrolled into view in the second pane.
`void`	`setSecondStartRow(int r)` If panes are split so that there is both a top and bottom databody pane, specifies the first row to be scrolled into view in the bottom pane.
`void`	`setSelection(Selection selection)` Sets the `Selection` instance that indicates which data cells and header cells are selected in the pivot table.
`void`	`setSizing(java.lang.String sizing)` Specifies how the pivot table's size ( width/height ) is determined.
`void`	`setSizingManager(SizingManager sizing)` Sets the `SizingManager` instance that controls overrides for row heights, column widths, row header column widths, and column header row heights.
`void`	`setSortListener(javax.el.MethodExpression sortListener)` Sets the sort listener.
`void`	`setSortMode(java.lang.String sortMode)` Specifies the sort mode.
`void`	`setSplitColumn(int c)` Sets the splitColumn attribute.
`void`	`setSplitListener(javax.el.MethodExpression splitListener)` Sets the split listener.
`void`	`setSplitMode(java.lang.String splitMode)` Specifies the split mode, which controls whether the split-panes feature is enabled.
`void`	`setSplitRow(int r)` Sets the `splitRow` attribute.
`protected void`	`setStartAndSplitSliceAfterDrill(DrillEvent drillEvent, QDR drilledMemberQdr)` Sets the start row/column and split row/column of the drilled edge after a drill.
`void`	`setStartColumn(int c)` Specifies the first column of data be scrolled into view in this pivot table.
`void`	`setStartRow(int r)` Specifies the first row of data to be scrolled into view in this pivot table.
`void`	`setStatusBarRendered(boolean rendered)` Specifies whether to render the status bar in the pivot table.
`void`	`setStyleClass(java.lang.String styleClass)` Sets a CSS style class to use for this component.
`void`	`setSummary(java.lang.String summary)` Sets a summary of this pivot table's purpose and structure for user agents rendering to non-visual media / screen readers.
`void`	`setValue(java.lang.Object value)` Specifies the pivot table's data model, which should be an instance of `DataModel`.
`void`	`setVarStatus(java.lang.String varStatus)` Sets Name of the EL variable used to reference the `varStatus` information.
`void`	`setVisible(boolean visible)` Sets the visibility of the component.
`protected void`	`sort(SortEvent.SortType type, java.util.Map<java.lang.String,java.lang.Object> properties)` Sorts the data in the Pivot Table.
`protected boolean`	`visitChildren(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)`
`protected boolean`	`visitData(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback visitCallback)`

Methods inherited from class oracle.adf.view.faces.bi.component.pivotTable.UIGrid
cleanInternalState, clearCurrencyStringCache, decodeChildrenImpl, encodeBegin, encodeEnd, getCellData, getCellData, getCellIndex, getCellKey, getClientCellKey, getClientKeyManager, getColumnCount, getContainerClientId, getDataModel, getDataModel, getRowCount, getVar, invokeOnComponent, isCellAvailable, isCellAvailable, isPivotTableEvent, preCellDataChange, processComponent, processDecodes, processSaveState, resetClientKeyManager, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setCellIndex, setCellKey, setClientCellKey, setVar, updateChildrenImpl, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, validateChildren

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE
```
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
```
  - VALUE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY
```
  - PARTIAL_TRIGGERS_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
```
  - DRILLING_ENABLED_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DRILLING_ENABLED_KEY
```
  - DRILL_REQUESTING_LISTENER_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DRILL_REQUESTING_LISTENER_KEY
```
  - DRILL_REQUESTED_LISTENER_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DRILL_REQUESTED_LISTENER_KEY
```
  - SORT_LISTENER_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SORT_LISTENER_KEY
```
  - SPLIT_LISTENER_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SPLIT_LISTENER_KEY
```
  - PIVOT_LISTENER_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey PIVOT_LISTENER_KEY
```
  - DRILL_ACTION_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DRILL_ACTION_KEY
```
  - AUTOINDENT_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTOINDENT_KEY
```
  - INDENT_ENABLED_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey INDENT_ENABLED_KEY
```
  - LAYER_LABEL_MODE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey LAYER_LABEL_MODE_KEY
```
  - PIVOT_LABEL_VISIBLE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey PIVOT_LABEL_VISIBLE_KEY
```
  - PIVOT_ENABLED_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey PIVOT_ENABLED_KEY
```
  - SORT_MODE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SORT_MODE_KEY
```
  - HEADER_SORT_MODE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_SORT_MODE_KEY
```
  - START_ROW_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey START_ROW_KEY
```
  - START_COLUMN_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey START_COLUMN_KEY
```
  - SECOND_START_ROW_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SECOND_START_ROW_KEY
```
  - SECOND_START_COLUMN_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SECOND_START_COLUMN_KEY
```
  - SPLIT_ROW_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SPLIT_ROW_KEY
```
  - SPLIT_COLUMN_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SPLIT_COLUMN_KEY
```
  - SPLIT_MODE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SPLIT_MODE_KEY
```
  - ROW_HEADER_START_LAYER_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_HEADER_START_LAYER_KEY
```
  - COLUMN_HEADER_START_LAYER_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_HEADER_START_LAYER_KEY
```
  - START_ROW_PIXEL_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey START_ROW_PIXEL_KEY
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - START_COLUMN_PIXEL_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey START_COLUMN_PIXEL_KEY
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - SECOND_START_ROW_PIXEL_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SECOND_START_ROW_PIXEL_KEY
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - SECOND_START_COLUMN_PIXEL_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SECOND_START_COLUMN_PIXEL_KEY
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - ROW_HEADER_START_PIXEL_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_HEADER_START_PIXEL_KEY
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - COLUMN_HEADER_START_PIXEL_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_HEADER_START_PIXEL_KEY
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - HEADER_FORMAT_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_FORMAT_KEY
```
  - DATA_FORMAT_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DATA_FORMAT_KEY
```
  - INLINE_STYLE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
```
  - SIZING_MANAGER_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SIZING_MANAGER_KEY
```
  - SELECTION_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTION_KEY
```
  - STATUS_BAR_RENDERED_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey STATUS_BAR_RENDERED_KEY
```
  - DATA_FORMAT_MANAGER_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DATA_FORMAT_MANAGER_KEY
```
  - HEADER_FORMAT_MANAGER_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_FORMAT_MANAGER_KEY
```
  - CONTENT_DELIVERY_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
```
  - COLUMN_FETCH_SIZE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_FETCH_SIZE_KEY
```
  - ROW_FETCH_SIZE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_FETCH_SIZE_KEY
```
  - PREFERRED_COLUMN_HEADER_HEIGHT_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey PREFERRED_COLUMN_HEADER_HEIGHT_KEY
```
  - PREFERRED_ROW_HEADER_WIDTH_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey PREFERRED_ROW_HEADER_WIDTH_KEY
```
  - CLIENT_LISTENERS_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
```
  - CELL_IMAGE_CLICK_LISTENER_KEY
```
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CELL_IMAGE_CLICK_LISTENER_KEY
```
    Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.
  - CELL_IMAGE_CLICK_ACTION_KEY
```
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CELL_IMAGE_CLICK_ACTION_KEY
```
    Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.
  - STYLE_CLASS_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
```
  - SUMMARY_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SUMMARY_KEY
```
  - VISIBLE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
```
  - EMPTY_TEXT_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_KEY
```
  - CUSTOMIZATION_ID_KEY
```
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
```
    Deprecated. This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
  - PERSIST_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY
```
  - DONT_PERSIST_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY
```
  - VAR_STATUS_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey VAR_STATUS_KEY
```
  - CONTEXT_MENU_ID_KEY
```
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTEXT_MENU_ID_KEY
```
    Deprecated. Use the contextMenu facet instead.
  - BODY_CONTEXT_MENU_ID_KEY
```
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey BODY_CONTEXT_MENU_ID_KEY
```
    Deprecated. Use the bodyContextMenu facet instead.
  - SIZING_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SIZING_KEY
```
  - MODEL_NAME_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey MODEL_NAME_KEY
```
  - ACTIVE_CELL_KEY_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTIVE_CELL_KEY_KEY
```
  - SCROLL_POLICY_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_POLICY_KEY
```
  - SHRINK_TO_FIT_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHRINK_TO_FIT_KEY
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - DATA_CELL_CONTENT_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DATA_CELL_CONTENT_KEY
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - DEFAULT_GRAPH_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DEFAULT_GRAPH_KEY
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - GRAPH_SCREENREADER_MODE
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey GRAPH_SCREENREADER_MODE
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - CONTENT_DELIVERY_IMMEDIATE
```
public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE
```
    See Also:
    Constant Field Values
  - CONTENT_DELIVERY_LAZY
```
public static final java.lang.String CONTENT_DELIVERY_LAZY
```
    See Also:
    Constant Field Values
  - CONTENT_DELIVERY_WHEN_AVAILABLE
```
public static final java.lang.String CONTENT_DELIVERY_WHEN_AVAILABLE
```
    See Also:
    Constant Field Values
  - SCROLL_POLICY_AUTO
```
public static final java.lang.String SCROLL_POLICY_AUTO
```
    See Also:
    Constant Field Values
  - SCROLL_POLICY_PAGE
```
public static final java.lang.String SCROLL_POLICY_PAGE
```
    See Also:
    Constant Field Values
  - SCROLL_POLICY_SCROLL
```
public static final java.lang.String SCROLL_POLICY_SCROLL
```
    See Also:
    Constant Field Values
  - SORT_MODE_GROUPED
```
public static final java.lang.String SORT_MODE_GROUPED
```
    See Also:
    Constant Field Values
  - SORT_MODE_UNGROUPED
```
public static final java.lang.String SORT_MODE_UNGROUPED
```
    See Also:
    Constant Field Values
  - SORT_MODE_NONE
```
public static final java.lang.String SORT_MODE_NONE
```
    See Also:
    Constant Field Values
  - SPLIT_MODE_ENABLED
```
public static final java.lang.String SPLIT_MODE_ENABLED
```
    See Also:
    Constant Field Values
  - SPLIT_MODE_DISABLED
```
public static final java.lang.String SPLIT_MODE_DISABLED
```
    See Also:
    Constant Field Values
  - LAYER_LABEL_MODE_RENDERED
```
public static final java.lang.String LAYER_LABEL_MODE_RENDERED
```
    See Also:
    Constant Field Values
  - LAYER_LABEL_MODE_HIDDEN
```
public static final java.lang.String LAYER_LABEL_MODE_HIDDEN
```
    See Also:
    Constant Field Values
  - CONTEXT_MENU_FACET
```
public static final java.lang.String CONTEXT_MENU_FACET
```
    See Also:
    Constant Field Values
  - BODY_CONTEXT_MENU_FACET
```
public static final java.lang.String BODY_CONTEXT_MENU_FACET
```
    See Also:
    Constant Field Values
  - 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
  - PIVOTTABLE_NAME
```
public static final java.lang.String PIVOTTABLE_NAME
```
    For internal use only.
    
    See Also:
    Constant Field Values
    For internal use only. Application developers should not use this
- Constructor Detail
  - UIPivotTable
```
public UIPivotTable()
```
    Constructs a new Pivot Table.
- Method Detail
  - getBeanType
```
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
```
    Gets the bean type.
    
    Overrides:
    
    getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase
    
    Returns:
    the bean type
  - setPartialTriggers
```
public void setPartialTriggers(java.lang.String[] ids)
```
    Sets partial triggers on this component.
    
    Parameters:
    ids - the partial triggers
  - getPartialTriggers
```
public java.lang.String[] getPartialTriggers()
```
    Gets the partial triggers of this component.
    
    Returns:
    the partial triggers of this component
  - getDrillRequestingListener
```
public final javax.el.MethodExpression getDrillRequestingListener()
```
    Gets the "before drill" listener.
    
    Returns:
    the "before drill" listener
  - setDrillRequestingListener
```
public final void setDrillRequestingListener(javax.el.MethodExpression drillRequestingListener)
```
    Sets the "before drill" listener
    
    Parameters:
    drillRequestingListener - the "before drill" listener
  - getDrillRequestedListener
```
public final javax.el.MethodExpression getDrillRequestedListener()
```
    Gets the "after drill" listener.
    
    Returns:
    the "after drill" listener
  - setDrillRequestedListener
```
public final void setDrillRequestedListener(javax.el.MethodExpression drillRequestedListener)
```
    Sets the "after drill" listener
    
    Parameters:
    drillRequestedListener - the "after drill" listener
  - getDrillAction
```
public final javax.el.MethodExpression getDrillAction()
```
    Gets the drill action.
    
    Returns:
    the drill action
  - setDrillAction
```
public final void setDrillAction(javax.el.MethodExpression drillAction)
```
    Sets the drill action.
    
    Parameters:
    drillAction - the drill action
  - queueEvent
```
public void queueEvent(javax.faces.event.FacesEvent e)
```
    Queues the specified event.
    
    Overrides:
    
    queueEvent in class UIGrid
    
    Parameters:
    e - the event to queue
  - addDrillListener
```
public void addDrillListener(DrillListener listener)
```
    Adds a drill listener.
    
    Parameters:
    listener - the drill listener to add
  - removeDrillListener
```
public void removeDrillListener(DrillListener listener)
```
    Removes the specified drill listener. Note that removeDrillListener must not be called with the same listener object that was passed to addDrillListener. Due to component state saving and restoring, the actual listener objects on this list will vary. Call getDrillListeners to get the current list of listener objects.
  - getDrillListeners
```
public DrillListener[] getDrillListeners()
```
    Gets the drill listeners.
    
    Returns:
    the drill listeners
  - sort
```
protected void sort(SortEvent.SortType type,
        java.util.Map<java.lang.String,java.lang.Object> properties)
```
    Sorts the data in the Pivot Table.
    
    Parameters:
    type - the type of sort, for example a column sort
    properties - conveys details like the column number, sort direction, and so on
  - addSortListener
```
public void addSortListener(SortListener listener)
```
    Adds a sort listener.
    
    Parameters:
    listener - the sort listener to add
  - removeSortListener
```
public void removeSortListener(SortListener listener)
```
    Removes the specified sort listener. Note that removeSortListener must not be called with the same listener object that was passed to addSortListener. Due to component state saving and restoring, the actual listener objects on this list will vary. Call getSortListeners to get the current list of listener objects.
  - getSortListeners
```
public SortListener[] getSortListeners()
```
    Gets the sort listeners.
    
    Returns:
    the sort listeners
  - setSortListener
```
public final void setSortListener(javax.el.MethodExpression sortListener)
```
    Sets the sort listener.
    
    Parameters:
    sortListener - the sort listener
  - getSortListener
```
public final javax.el.MethodExpression getSortListener()
```
    Gets the sort listener.
    
    Returns:
    the sort listener
  - addSplitListener
```
public void addSplitListener(SplitListener listener)
```
    Adds a split listener.
    
    Parameters:
    listener - the split listener to add
  - removeSplitListener
```
public void removeSplitListener(SplitListener listener)
```
    Removes the specified split listener. Note that removeSplitListener must not be called with the same listener object that was passed to addSplitListener. Due to component state saving and restoring, the actual listener objects on this list will vary. Call getSplitListeners to get the current list of listener objects.
  - getSplitListeners
```
public SplitListener[] getSplitListeners()
```
    Gets the split listeners.
    
    Returns:
    the split listeners
  - setSplitListener
```
public final void setSplitListener(javax.el.MethodExpression splitListener)
```
    Sets the split listener.
    
    Parameters:
    splitListener - the split listener
  - getSplitListener
```
public final javax.el.MethodExpression getSplitListener()
```
    Gets the split listener.
    
    Returns:
    the split listener
  - addPivotListener
```
public void addPivotListener(PivotListener listener)
```
    Adds a pivot listener.
    
    Parameters:
    listener - the pivot listener to add
  - removePivotListener
```
public void removePivotListener(PivotListener listener)
```
    Removes the specified pivot listener. Note that removePivotListener must not be called with the same listener object that was passed to addPivotListener. Due to component state saving and restoring, the actual listener objects on this list will vary. Call getPivotListeners to get the current list of listener objects.
  - getPivotListeners
```
public PivotListener[] getPivotListeners()
```
    Gets the pivot listeners.
    
    Returns:
    the pivot listeners
  - setPivotListener
```
public final void setPivotListener(javax.el.MethodExpression pivotListener)
```
    Sets the pivot listener.
    
    Parameters:
    pivotListener - the pivot listener
  - getPivotListener
```
public final javax.el.MethodExpression getPivotListener()
```
    Gets the pivot listener.
    
    Returns:
    the pivot listener
  - addCellImageClickListener
```
@Deprecated
public void addCellImageClickListener(CellImageClickListener listener)
```
    Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.
  - removeCellImageClickListener
```
@Deprecated
public void removeCellImageClickListener(CellImageClickListener listener)
```
    Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.
  - getCellImageClickListener
```
@Deprecated
public final javax.el.MethodExpression getCellImageClickListener()
```
    Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.
  - getCellImageClickListeners
```
@Deprecated
public CellImageClickListener[] getCellImageClickListeners()
```
    Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.
  - setCellImageClickListener
```
@Deprecated
public final void setCellImageClickListener(javax.el.MethodExpression cellImageClickListener)
```
    Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.
  - getCellImageClickAction
```
@Deprecated
public final javax.el.MethodExpression getCellImageClickAction()
```
    Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.
  - setCellImageClickAction
```
@Deprecated
public final void setCellImageClickAction(javax.el.MethodExpression cellImageClickAction)
```
    Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.
  - getAction
```
public javax.faces.el.MethodBinding getAction()
```
    For internal use only.
    
    Specified by:
    
    getAction in interface javax.faces.component.ActionSource
    
    For internal use only. Application developers should not use this
  - setAction
```
public void setAction(javax.faces.el.MethodBinding action)
```
    For internal use only.
    
    Specified by:
    
    setAction in interface javax.faces.component.ActionSource
    
    For internal use only. Application developers should not use this
  - getActionExpression
```
public javax.el.MethodExpression getActionExpression()
```
    For internal use only.
    
    Specified by:
    
    getActionExpression in interface javax.faces.component.ActionSource2
    
    For internal use only. Application developers should not use this
  - setActionExpression
```
public void setActionExpression(javax.el.MethodExpression action)
```
    For internal use only.
    
    Specified by:
    
    setActionExpression in interface javax.faces.component.ActionSource2
    
    For internal use only. Application developers should not use this
  - getActionListener
```
public javax.faces.el.MethodBinding getActionListener()
```
    For internal use only.
    
    Specified by:
    
    getActionListener in interface javax.faces.component.ActionSource
    
    For internal use only. Application developers should not use this
  - setActionListener
```
public void setActionListener(javax.faces.el.MethodBinding listener)
```
    Do not use this method to set any ActionListeners. Use the specific APIs such as setDrillListener, setPivotListener, etc.
    
    Specified by:
    
    setActionListener in interface javax.faces.component.ActionSource
    
    For internal use only. Application developers should not use this
  - addActionListener
```
public void addActionListener(javax.faces.event.ActionListener listener)
```
    Do not use this method to add any ActionListeners. Use the specific APIs, such as addDrillListener, addPivotListener, etc.
    
    Specified by:
    
    addActionListener in interface javax.faces.component.ActionSource
    
    For internal use only. Application developers should not use this
  - removeActionListener
```
public void removeActionListener(javax.faces.event.ActionListener listener)
```
    Do not use this method to remove any ActionListeners. Use the specific APIs, such as removeDrillListener, removePivotListener, etc.
    
    Specified by:
    
    removeActionListener in interface javax.faces.component.ActionSource
    
    For internal use only. Application developers should not use this
  - getActionListeners
```
public javax.faces.event.ActionListener[] getActionListeners()
```
    For internal use only.
    
    Specified by:
    
    getActionListeners in interface javax.faces.component.ActionSource
    
    For internal use only. Application developers should not use this
  - isImmediate
```
public boolean isImmediate()
```
    Returns false.
    
    Specified by:
    
    isImmediate in interface javax.faces.component.ActionSource
    
    Returns:
    false
  - setImmediate
```
public void setImmediate(boolean immediate)
```
    This method does nothing.
    
    Specified by:
    
    setImmediate in interface javax.faces.component.ActionSource
    
    Parameters:
    immediate - ignored
  - getActionType
```
public UIPivotTable.ActionType getActionType()
```
    Gets the action type.
    
    Returns:
    the action type
  - setActionType
```
public void setActionType(UIPivotTable.ActionType actionType)
```
    Sets the action type.
    
    Parameters:
    actionType -
  - drill
```
protected void drill(DrillEvent drillEvent)
```
    Performs a drill on the Pivot Table.
    
    Parameters:
    drillEvent - specifies the header cell to drill and the drill type
  - setStartAndSplitSliceAfterDrill
```
protected void setStartAndSplitSliceAfterDrill(DrillEvent drillEvent,
                                   QDR drilledMemberQdr)
```
    Sets the start row/column and split row/column of the drilled edge after a drill. Doesn't touch those values for the other edge, which is assumed to be unchanged by the operation.
    
    Parameters:
    drillEvent - specifies the header cell to drill and the drill type
    drilledMemberQdr - QDR of the header cell that was drilled
  - broadcast
```
public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
```
    Description copied from class: UIGrid
    
    Delivers a wrapped event to the appropriate component. If the event is a special wrapped event, it is unwrapped.
    
    Overrides:
    
    broadcast in class UIGrid
    
    Parameters:
    event - a FacesEvent
    
    Throws:
    
    javax.faces.event.AbortProcessingException
  - fireEventToAppListener
```
protected void fireEventToAppListener(javax.faces.context.FacesContext context,
                          javax.faces.event.FacesEvent event)
```
    Fires the specified event to the default action listener.
    
    Parameters:
    context - the Faces Context
    event - the event to fire
  - setValue
```
public final void setValue(java.lang.Object value)
```
    Specifies the pivot table's data model, which should be an instance of DataModel.
    
    Parameters:
    value - the data model
  - getValue
```
public final java.lang.Object getValue()
```
    Retrieves the pivot table's data model, which should be an instance of DataModel.
    
    Specified by:
    
    getValue in class UIGrid
    
    Returns:
    the data model
  - setDrillingEnabled
```
public void setDrillingEnabled(boolean b)
```
    Specifies whether drilling is enabled. Drilling is enabled by default.
    In addition to this attribute, drilling requires DataAccess.getMemberMetadata to support MetadataMap.METADATA_DRILLSTATE, and DataAccess.getLayerMetadata to support LayerMetadataMap.LAYER_METADATA_HIERARCHICAL. DataDirector.drillOK is not called, as it provides no information not provided by the preceding methods.
    
    Parameters:
    b - true to enable drilling, false to disable drilling
  - isDrillingEnabled
```
public boolean isDrillingEnabled()
```
    Retrieves whether drilling is enabled. Drilling is enabled by default.
    In addition to this attribute, drilling requires DataAccess.getMemberMetadata to support MetadataMap.METADATA_DRILLSTATE, and DataAccess.getLayerMetadata to support LayerMetadataMap.LAYER_METADATA_HIERARCHICAL. DataDirector.drillOK is not called, as it provides no information not provided by the preceding methods.
    
    Returns:
    true if drilling is enabled, false if drilling is disabled
  - getLocalValue
```
public java.lang.Object getLocalValue()
```
    Application developers should not call this method.
    
    For internal use only. Application developers should not use this
  - createDataModel
```
public DataModel createDataModel(DataModel current,
                        java.lang.Object value)
```
    Creates the pivot table's data model, as an instance of DataModel.
    
    Specified by:
    
    createDataModel in class UIGrid
    
    Parameters:
    current - the current DataModel, or null if there is none.
    value - this is the value returned from UIGrid.getValue()
    
    Returns:
    a data model instance
  - createVarStatusMap
```
protected java.util.Map<java.lang.String,java.lang.Object> createVarStatusMap()
```
    Creates the map that backs the "varStatus" EL functionality.
    
    Overrides:
    
    createVarStatusMap in class UIGrid
    
    Returns:
    the varStatus map
  - getCellFormat
```
public CellFormat getCellFormat()
```
    Gets the CellFormat for the current cell.
    
    Returns:
    the CellFormat for the current cell
  - getRawValue
```
public java.lang.Object getRawValue()
```
    Gets the raw value of the current cell.
    
    Returns:
    the raw value of the current cell
  - getCellComponent
```
public javax.faces.component.UIComponent getCellComponent()
```
    Gets the stamped component for the current cell.
    
    Returns:
    the stamped component for the current cell
  - getStamps
```
public java.util.List<javax.faces.component.UIComponent> getStamps()
```
    Gets the UIComponents that are considered stamps. This implementation simply returns the children of this component.
    
    Specified by:
    
    getStamps in class UIGrid
    
    Returns:
    a List of stamps of type UIComponent
  - getHeaderCell
```
protected UIHeaderCell getHeaderCell()
```
    Gets the UIHeaderCell for this Pivot Table.
    
    Returns:
    the UIHeaderCell for this Pivot Table
  - getDataCell
```
protected UIDataCell getDataCell(java.lang.String dataAttribute)
```
    Gets the UIDataCell for this Pivot Table. Note: dataAttribute has been deprecated. Users should use a switcher instead.
    
    Parameters:
    dataAttribute - deprecated. Please use a switcher instead of this parameter.
    
    Returns:
    the UIDataCell for this Pivot Table
  - getStamps
```
protected java.util.List<javax.faces.component.UIComponent> getStamps(UIHeaderCell headerCell)
```
    Returns the component(s) stamped into the header cell.
    
    Parameters:
    headerCell - the header cell
    
    Returns:
    the component(s) stamped into the header cell
  - getStamps
```
protected java.util.List<javax.faces.component.UIComponent> getStamps(UIDataCell dataCell)
```
    Returns the component(s) stamped into the data cell.
    
    Parameters:
    dataCell - the data cell
    
    Returns:
    the component(s) stamped into the data cell
  - resetStamps
```
protected void resetStamps()
```
    Currently this method is not used.
  - getCurrentCellContext
```
public java.lang.Object getCurrentCellContext()
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - getHeaderCellFormat
```
protected CellFormat getHeaderCellFormat(javax.faces.context.FacesContext context,
                             javax.el.MethodExpression headerFormat,
                             HeaderFormatManager headerFormatManager,
                             DataModel model,
                             int edge,
                             int layer,
                             int slice,
                             QDR qdr,
                             java.lang.Object value)
```
    Gets the CellFormat for the header cell indicated by the parameters.
    
    Parameters:
    context - the Faces Context
    headerFormat - the headerFormat method expression
    headerFormatManager - the HeaderFormatManager
    model - the DataModel
    edge - the edge of the header cell, either DataDirector.COLUMN_EDGE or DataDirector.ROW_EDGE
    layer - the layer of the header cell
    slice - the slice of the header cell
    qdr - the QDR of the header cell
    value - the value in the header cell
    
    Returns:
    the CellFormat for the header cell
  - getDataCellFormat
```
protected CellFormat getDataCellFormat(javax.faces.context.FacesContext context,
                           javax.el.MethodExpression dataFormat,
                           DataFormatManager dataFormatManager,
                           DataModel model,
                           int row,
                           int column,
                           QDR qdr,
                           java.lang.Object value)
```
    Gets the CellFormat for the data cell indicated by the parameters.
    
    Parameters:
    context - the Faces Context
    dataFormat - the dataFormat method expression
    dataFormatManager - the DataFormatManager
    model - the DataModel
    row - the row of the data cell
    column - the column of the data cell
    qdr - the QDR of the data cell
    value - the value in the data cell
    
    Returns:
    the CellFormat for the data cell
  - postCellDataChange
```
protected void postCellDataChange()
```
    Description copied from class: UIGrid
    
    Sets up this component to use the new cellData. This method should be called right after the cellData changes. It sets up the var EL variable to be the current cellData. It also sets up the internal states of all the stamps of this component to match this new cellData.
    
    Overrides:
    
    postCellDataChange in class UIGrid
  - getMeasureName
```
protected java.lang.String getMeasureName(QDR qdr)
```
    Gets the name of the measure dimension of the specified QDR.
    
    Parameters:
    qdr -
    
    Returns:
    the name of the measure dimension of the specified QDR
  - processFacetsAndChildren
```
protected void processFacetsAndChildren(javax.faces.context.FacesContext context,
                            javax.faces.event.PhaseId phaseId)
```
    Description copied from class: UIGrid
    
    Process this component's facets and children. This method should call UIGrid.processComponent(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.event.PhaseId) as many times as necessary for each facet and child. UIGrid.processComponent(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.event.PhaseId) may be called repeatedly for the same child if that child is being stamped.
    
    Specified by:
    
    processFacetsAndChildren in class UIGrid
    
    Parameters:
    context - the Faces Context
    phaseId - the phase ID
  - getVarStatus
```
public final java.lang.String getVarStatus()
```
    Gets Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The varStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include:
    - "model" - returns the DataModel for the pivot table
    - "index" - returns the zero based row index
    Specified by:
    
    getVarStatus in class UIGrid
    
    Returns:
    the varStatus value
    See Also:
    UIGrid.createVarStatusMap()
  - setVarStatus
```
public final void setVarStatus(java.lang.String varStatus)
```
    Sets Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The varStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include:
    - "model" - returns the DataModel for the pivot table
    - "index" - returns the zero based row index
    Parameters:
    varStatus - the new varStatus value
  - getSizingManager
```
public final SizingManager getSizingManager()
```
    Retrieves the SizingManager instance that controls overrides for row heights, column widths, row header column widths, and column header row heights.
    
    Returns:
    a SizingManager instance
  - setSizingManager
```
public final void setSizingManager(SizingManager sizing)
```
    Sets the SizingManager instance that controls overrides for row heights, column widths, row header column widths, and column header row heights.
    
    Parameters:
    sizing - a SizingManager instance
  - getSelection
```
public final Selection getSelection()
```
    Retrieves the Selection instance that indicates which data cells and header cells are selected in the pivot table.
    
    Returns:
    a Selection instance
  - setSelection
```
public final void setSelection(Selection selection)
```
    Sets the Selection instance that indicates which data cells and header cells are selected in the pivot table.
    
    Parameters:
    selection - a Selection instance
  - isStatusBarRendered
```
public final boolean isStatusBarRendered()
```
    Retrieves a boolean indicating whether the status bar is rendered in the pivot table. By default, it is not rendered.
    
    Returns:
    true if the status bar is rendered, false otherwise
  - setStatusBarRendered
```
public final void setStatusBarRendered(boolean rendered)
```
    Specifies whether to render the status bar in the pivot table. By default, it is not rendered.
    
    Parameters:
    rendered - true to render the status bar, false otherwise
  - getFamily
```
public java.lang.String getFamily()
```
    Returns the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance.
    
    Specified by:
    
    getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase
    
    Returns:
    the identifier of the component family to which this component belongs
  - setStartRow
```
public void setStartRow(int r)
```
    Specifies the first row of data to be scrolled into view in this pivot table. If panes are split so that there is both a top and bottom databody pane, this method controls the top pane. Row indexes begin at zero.
    A startRow ≥ numRows indicates "scroll all the way to the end," where numRows is the number of rows in the Pivot Table (if rows are not split) or the splitRow (if rows are split).
    For best results, callers are advised to use this method in preference to setting the property directly.
    
    Parameters:
    r - the index of the first row to be scrolled into view
  - getStartRow
```
public int getStartRow()
```
    Retrieves the index of the first row that is scrolled into view in this pivot table. If panes are split so that there is both a top and bottom databody pane, this method is for the top pane. Row indexes begin at zero.
    
    Returns:
    the index of the first row to be scrolled into view
  - setStartColumn
```
public void setStartColumn(int c)
```
    Specifies the first column of data be scrolled into view in this pivot table. If panes are split so that there is both a left and right databody pane, this method controls the first pane. Column indexes begin at zero.
    A startColumn ≥ numColumns indicates "scroll all the way to the end," where numColumns is the number of columns in the Pivot Table (if columns are not split) or splitColumn (if columns are split).
    For best results, callers are advised to use this method in preference to setting the property directly.
    
    Parameters:
    c - the index of the first column to be scrolled into view
  - getStartColumn
```
public int getStartColumn()
```
    Retrieves the index of the first column that is scrolled into view in this pivot table. If panes are split so that there is both a left and right databody pane, this method is for the first pane. Column indexes begin at zero.
    
    Returns:
    the index of the first column to be scrolled into view
  - setSecondStartRow
```
public void setSecondStartRow(int r)
```
    If panes are split so that there is both a top and bottom databody pane, specifies the first row to be scrolled into view in the bottom pane. Row indexes begin at zero.
    A secondStartRow ≥ the number of rows in the Pivot Table indicates "scroll all the way to the end."
    For best results, callers are advised to use this method in preference to setting the property directly.
    
    Parameters:
    r - the index of the first row to be scrolled into view in the bottom pane
  - getSecondStartRow
```
public int getSecondStartRow()
```
    If panes are split so that there is both a top and bottom databody pane, retrieves the index of the first row to be scrolled into view in the bottom pane. Row indexes begin at zero.
    
    Returns:
    the index of the first row to be scrolled into view in the bottom pane
  - setSecondStartColumn
```
public void setSecondStartColumn(int c)
```
    If panes are split so that there is both a left and right databody pane, specifies the first column to be scrolled into view in the second pane. Column indexes begin at zero.
    A secondStartColumn ≥ the number of columns in the Pivot Table indicates "scroll all the way to the end."
    For best results, callers are advised to use this method in preference to setting the property directly.
    
    Parameters:
    c - the index of the first column to be scrolled into view in the second pane
  - getSecondStartColumn
```
public int getSecondStartColumn()
```
    If panes are split so that there is both a left and right databody pane, retrieves the index of the first column to be scrolled into view in the second pane. Column indexes begin at zero.
    
    Returns:
    the index of the first column to be scrolled into view in the second pane
  - setSplitRow
```
public void setSplitRow(int r)
```
    Sets the splitRow attribute. If panes are split so that there is both a top and bottom databody pane, then:
    - Rows 0 to (splitRow-1) can be viewed in the top pane, and rows splitRow to (rowExtent-1) can be viewed in the bottom pane.
    - The following relationships must be satisfied: 0 &le startRow < splitRow &le secondStartRow < rowExtent. This ensures that each pane is non-empty and contains a valid startRow.
    To remove this split, set splitRow to -1.
    If splitRow = 0 or splitRow ≥ rowExtent, it will be set to -1 during rendering. Otherwise, if inconsistent values are set, the two startRow attributes will be adjusted during rendering to be consistent with the splitRow.
    Aside from this deferred consistency check, this method has no effect on the startRow and secondStartRow. The caller may wish to set these attributes too; e.g. to have both panes scrolled to the splitRow, set both attributes to splitRow.
    Note that row indexes begin at zero, and rowExtent is the number of rows in the Pivot Table.
    Parameters:
    r - the index of the row at which panes should be split, satisfying 0 < r < rowExtent, or -1 to indicate no row split
  - getSplitRow
```
public int getSplitRow()
```
    Gets the splitRow attribute. If panes are split so that there is both a top and bottom databody pane, then:
    - Rows 0 to (splitRow-1) can be viewed in the top pane, and rows splitRow to (rowExtent-1) can be viewed in the bottom pane.
    - The following relationships must be satisfied: 0 &le startRow < splitRow &le secondStartRow < rowExtent. This ensures that each pane is non-empty and contains a valid startRow.
    If there is no such split, then splitRow is -1.
    If splitRow = 0 or splitRow ≥ rowExtent, it will be set to -1 during rendering. Otherwise, if inconsistent values are set, the two startRow attributes will be adjusted during rendering to be consistent with the splitRow. Until that time, if inconsistent values are set, getters such as getSplitRow will return the inconsistent values.
    Note that row indexes begin at zero, and rowExtent is the number of rows in the Pivot Table.
    Returns:
    the index of the row at which panes are split, or -1 if there is no row split
  - setSplitColumn
```
public void setSplitColumn(int c)
```
    Sets the splitColumn attribute. If panes are split so that there is both a left and right databody pane, then:
    - Columns 0 to (splitColumn-1) can be viewed in the first pane, and columns splitColumn to (columnExtent-1) can be viewed in the second pane.
    - The following relationships must be satisfied: 0 &le startColumn < splitColumn &le secondStartColumn < columnExtent. This ensures that each pane is non-empty and contains a valid startColumn.
    If there is no such split, then splitColumn is -1.
    If splitColumn = 0 or splitColumn ≥ columnExtent, it will be set to -1 during rendering. Otherwise, if inconsistent values are set, the two startColumn attributes will be adjusted during rendering to be consistent with the splitColumn.
    Note that column indexes begin at zero, and columnExtent is the number of columns in the Pivot Table.
    Parameters:
    c - the index of the column at which panes should be split, satisfying 0 < c < columnExtent, or -1 to indicate no column split
  - getSplitColumn
```
public int getSplitColumn()
```
    Sets the splitColumn attribute. If panes are split so that there is both a left and right databody pane, then:
    - Columns 0 to (splitColumn-1) can be viewed in the first pane, and columns splitColumn to (columnExtent-1) can be viewed in the second pane.
    - The following relationships must be satisfied: 0 &le startColumn < splitColumn &le secondStartColumn < columnExtent. This ensures that each pane is non-empty and contains a valid startColumn.
    If there is no such split, then splitColumn is -1.
    If splitColumn = 0 or splitColumn ≥ columnExtent, it will be set to -1 during rendering. Otherwise, if inconsistent values are set, the two startColumn attributes will be adjusted during rendering to be consistent with the splitColumn.
    Note that column indexes begin at zero, and columnExtent is the number of columns in the Pivot Table.
    Returns:
    the index of the column at which panes are split, or -1 if there is no column split
  - getSplitMode
```
public java.lang.String getSplitMode()
```
    Retrieves the split mode, which controls whether the split-panes feature is enabled. Valid values are UIPivotTable.SPLIT_MODE_ENABLED and UIPivotTable.SPLIT_MODE_DISABLED. The default value is UIPivotTable.SPLIT_MODE_DISABLED.
    
    Returns:
    the split mode
  - setSplitMode
```
public void setSplitMode(java.lang.String splitMode)
```
    Specifies the split mode, which controls whether the split-panes feature is enabled. Valid values are UIPivotTable.SPLIT_MODE_ENABLED and UIPivotTable.SPLIT_MODE_DISABLED. The default value is UIPivotTable.SPLIT_MODE_DISABLED.
    
    Parameters:
    splitMode - the split mode
  - setRowHeaderStartLayer
```
public void setRowHeaderStartLayer(int layer)
```
    Specifies the first layer (column of header labels) to display in the row header. Layer indexes begin at zero.
    A startLayer ≥ the number of layers in the row header indicates "scroll all the way to the end."
    For best results, callers are advised to use this method in preference to setting the property directly.
    
    Parameters:
    layer - the index of the first layer to display
  - getRowHeaderStartLayer
```
public int getRowHeaderStartLayer()
```
    Retrieves the index of the first layer (column of header labels) displayed in the row header. Layer indexes begin at zero.
    A startLayer ≥ the number of layers in the row header indicates "scroll all the way to the end."
    
    Returns:
    the index of the first layer displayed in the row header
  - setColumnHeaderStartLayer
```
public void setColumnHeaderStartLayer(int layer)
```
    Specifies the first layer (row of header labels) to display in the column header. Layer indexes begin at zero.
    A startLayer ≥ the number of layers in the column header indicates "scroll all the way to the end."
    For best results, callers are advised to use this method in preference to setting the property directly.
    
    Parameters:
    layer - the index of the first layer to display
  - getColumnHeaderStartLayer
```
public int getColumnHeaderStartLayer()
```
    Retrieves the index of the first layer (row of header labels) displayed in the column header. Layer indexes begin at zero.
    A startLayer ≥ the number of layers in the column header indicates "scroll all the way to the end."
    
    Returns:
    the index of the first layer displayed in the column header
  - setRowFetchSize
```
public void setRowFetchSize(int rowFetchSize)
```
    Specifies the number of rows to fetch in each pivot table block that is downloaded to the user agent / browser. The default value is -1, which means that the pivot table will render using its internal default, which is currently 25 rows, but subject to change.
    
    Parameters:
    rowFetchSize - the number of rows to fetch in each pivot table block that is downloaded to the user agent / browser
  - getRowFetchSize
```
public int getRowFetchSize()
```
    Retrieves the number of rows to fetch in each pivot table block that is downloaded to the user agent / browser. The default value is -1, which means that the pivot table will render using its internal default, which is currently 25 rows, but subject to change.
    
    Returns:
    the number of rows to fetch in each pivot table block that is downloaded to the user agent / browser
  - setColumnFetchSize
```
public void setColumnFetchSize(int columnFetchSize)
```
    Specifies the number of columns to fetch in each pivot table block that is downloaded to the user agent / browser. The default value is -1, which means that the pivot table will render using its internal default, which is currently 10 columns, but subject to change.
    
    Parameters:
    columnFetchSize - the number of columns to fetch in each pivot table block that is downloaded to the user agent / browser
  - getColumnFetchSize
```
public int getColumnFetchSize()
```
    Retrieves the number of columns to fetch in each pivot table block that is downloaded to the user agent / browser. The default value is -1, which means that the pivot table will render using its internal default, which is currently 10 columns, but subject to change.
    
    Returns:
    the number of columns to fetch in each pivot table block that is downloaded to the user agent / browser
  - setPreferredRowHeaderWidth
```
public void setPreferredRowHeaderWidth(java.lang.String preferredWidth)
```
    Sets the preferred width of the row header, as a percentage of the total available width of the Pivot Table. Valid values are any number between 0 and 100 followed by "%", e.g. "25%", "33.3%".
    If no value is set, the internal default will be used for rendering. This value is currently 50%, but is subject to change.
    Example: if 30% is set, then the row header's preferred width is 30% of the available space, and the databody's preferred width is 70% of the available space.
    Any region (row header or databody) needing ≤ its preferred width gets exactly the space it needs, thus avoiding a scrollbar for that region.
    Any region needing more space gets its preferred width plus the unused portion of the other region's preferred width, if any. If this sum is x, then the region has a scrollbar if it needs more width than x.
    
    Parameters:
    preferredWidth - the preferred width of the row header, e.g "40%"
  - getPreferredRowHeaderWidth
```
public java.lang.String getPreferredRowHeaderWidth()
```
    Retrieves the preferred width of the row header, as a percentage of the total available width of the Pivot Table. Valid values are any number between 0 and 100 followed by "%", e.g. "25%", "33.3%".
    If no value is set, the internal default will be used for rendering. This value is currently 50%, but is subject to change.
    Example: if 30% is set, then the row header's preferred width is 30% of the available space, and the databody's preferred width is 70% of the available space.
    Any region (row header or databody) needing ≤ its preferred width gets exactly the space it needs, thus avoiding a scrollbar for that region.
    Any region needing more space gets its preferred width plus the unused portion of the other region's preferred width, if any. If this sum is x, then the region has a scrollbar if it needs more width than x.
    
    Returns:
    the preferred width of the row header, e.g "40%"
  - setPreferredColumnHeaderHeight
```
public void setPreferredColumnHeaderHeight(java.lang.String preferredHeight)
```
    Sets the preferred height of the column header, as a percentage of the total available height of the Pivot Table. Valid values are any number between 0 and 100 followed by "%", e.g. "25%", "33.3%".
    If no value is set, the internal default will be used for rendering. This value is currently 50%, but is subject to change.
    Example: if 30% is set, then the column header's preferred height is 30% of the available space, and the databody's preferred height is 70% of the available space.
    Any region (column header or databody) needing ≤ its preferred height gets exactly the space it needs, thus avoiding a scrollbar for that region.
    Any region needing more space gets its preferred height plus the unused portion of the other region's preferred height, if any. If this sum is x, then the region has a scrollbar if it needs more height than x.
    
    Parameters:
    preferredHeight - the preferred height of the column header, e.g "40%"
  - getPreferredColumnHeaderHeight
```
public java.lang.String getPreferredColumnHeaderHeight()
```
    Retrieves the preferred height of the column header, as a percentage of the total available height of the Pivot Table. Valid values are any number between 0 and 100 followed by "%", e.g. "25%", "33.3%".
    If no value is set, the internal default will be used for rendering. This value is currently 50%, but is subject to change.
    Example: if 30% is set, then the column header's preferred height is 30% of the available space, and the databody's preferred height is 70% of the available space.
    Any region (column header or databody) needing ≤ its preferred height gets exactly the space it needs, thus avoiding a scrollbar for that region.
    Any region needing more space gets its preferred height plus the unused portion of the other region's preferred height, if any. If this sum is x, then the region has a scrollbar if it needs more height than x.
    
    Returns:
    the preferred height of the column header, e.g "40%"
  - getLayerLabelMode
```
public java.lang.String getLayerLabelMode()
```
    Indicates whether layer/dimension labels appear above each row header layer and beside each column header layer. Values are LAYER_LABEL_MODE_RENDERED or LAYER_LABEL_MODE_HIDDEN. The default value is LAYER_LABEL_MODE_HIDDEN.
    This attribute in independent of the pivotLabelVisible attribute, which indicates whether layer names appear in the popup pivot handles. Typically, if this attribute is set to LAYER_LABEL_MODE_RENDERED and pivoting is enabled, then pivotLabelVisible should be set to true.
    
    Returns:
    LAYER_LABEL_MODE_RENDERED if layer/dimension names are rendered, LAYER_LABEL_MODE_HIDDEN if they are not
  - setLayerLabelMode
```
public void setLayerLabelMode(java.lang.String layerLabelMode)
```
    Specifies whether layer/dimension labels appear above each row header layer and beside each column header layer. Values are LAYER_LABEL_MODE_RENDERED or LAYER_LABEL_MODE_HIDDEN. The default value is LAYER_LABEL_MODE_HIDDEN.
    This attribute in independent of the pivotLabelVisible attribute, which indicates whether layer names appear in the popup pivot handles. Typically, if this attribute is set to LAYER_LABEL_MODE_RENDERED and pivoting is enabled, then pivotLabelVisible should be set to true.
    
    Parameters:
    layerLabelMode - LAYER_LABEL_MODE_RENDERED to render layer/dimension names, LAYER_LABEL_MODE_HIDDEN to prevent rendering them
  - isPivotLabelVisible
```
public boolean isPivotLabelVisible()
```
    Indicates whether layer/dimension names appear on pivot handles.
    
    Returns:
    true if layer/dimension names are visible on pivot handles, false if they are not
  - setPivotLabelVisible
```
public void setPivotLabelVisible(boolean visible)
```
    Specifies whether the names of layers/dimensions appear on pivot handles.
    
    Parameters:
    visible - true to display layer/dimension names on pivot handles, false to prevent their display
  - isPivotEnabled
```
public boolean isPivotEnabled()
```
    Indicates whether pivoting is enabled. Pivoting is enabled by default.
    In addition to this attribute, pivoting requires DataAccess.getLayerMetadata to support LayerMetadataMap.LAYER_METADATA_CANPIVOT, and requires DataDirector.pivotOK to be implemented. DataDirector.pivotCheck is not called, as it provides the same information as DataDirector.pivotOK.
    
    Returns:
    true if pivoting is enabled, false if pivoting is disabled
  - setPivotEnabled
```
public void setPivotEnabled(boolean enabled)
```
    Specifies whether pivoting is enabled. Pivoting is enabled by default.
    In addition to this attribute, pivoting requires DataAccess.getLayerMetadata to support LayerMetadataMap.LAYER_METADATA_CANPIVOT, and requires DataDirector.pivotOK to be implemented. DataDirector.pivotCheck is not called, as it provides the same information as DataDirector.pivotOK.
    
    Parameters:
    enabled - true if pivoting is enabled, false if pivoting is disabled
  - getSortMode
```
public java.lang.String getSortMode()
```
    Retrieves the sort mode. Either UIPivotTable.SORT_MODE_GROUPED, UIPivotTable.SORT_MODE_UNGROUPED, or UIPivotTable.SORT_MODE_NONE. The default value is UIPivotTable.SORT_MODE_GROUPED.
    
    Returns:
    the sort mode
  - setSortMode
```
public void setSortMode(java.lang.String sortMode)
```
    Specifies the sort mode. Either UIPivotTable.SORT_MODE_GROUPED, UIPivotTable.SORT_MODE_UNGROUPED, or UIPivotTable.SORT_MODE_NONE. The default value is UIPivotTable.SORT_MODE_GROUPED.
    
    Parameters:
    sortMode - the sort mode
  - getHeaderSortMode
```
public java.lang.String getHeaderSortMode()
```
    Retrieves the header sort mode. Either UIPivotTable.SORT_MODE_GROUPED or UIPivotTable.SORT_MODE_NONE. The default value is UIPivotTable.SORT_MODE_GROUPED.
    
    Returns:
    the sort mode
  - setHeaderSortMode
```
public void setHeaderSortMode(java.lang.String headerSortMode)
```
    Specifies the header sort mode. Either UIPivotTable.SORT_MODE_GROUPED or UIPivotTable.SORT_MODE_NONE. The default value is UIPivotTable.SORT_MODE_GROUPED.
    
    Parameters:
    headerSortMode - the header sort mode
  - setIndentEnabled
```
public void setIndentEnabled(boolean b)
```
    Specifies whether to indent the labels in the row header.
    
    Parameters:
    b - true to indent labels, false to align all the labels
  - isIndentEnabled
```
public boolean isIndentEnabled()
```
    Indicates whether row labels are indented.
    
    Returns:
    true if row labels are indented, false if they are all aligned
  - setVisible
```
public void setVisible(boolean visible)
```
    Sets the visibility of the component. If it is false, the component will be hidden on the client. Unlike rendered, this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When rendered is false, the component will not in any way be rendered, and cannot be made visible on the client.
    
    Parameters:
    visible - true if the component is visible, false if the component isn't visible
  - isVisible
```
public boolean isVisible()
```
    Retrieves the visibility of the component. If it is false, the component will be hidden on the client. Unlike rendered, this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When rendered is false, the component will not in any way be rendered, and cannot be made visible on the client.
    
    Returns:
    true if the component is visible, false if the component isn't visible
  - setAutoIndent
```
public void setAutoIndent(int i)
```
    Specifies how much to indent row labels for each level in a hierarchy. This method specifies the number of pixels to indent each level.
    
    Parameters:
    i - the number of pixels to indent each level
  - getAutoIndent
```
public int getAutoIndent()
```
    Retrieves the number of pixels that row labels of different levels are indented.
    
    Returns:
    the number of pixels that each level is indented
  - getDataFormatManager
```
public DataFormatManager getDataFormatManager()
```
    Retrieves the pivot table's DataFormatManager.
    
    Returns:
    the pivot table's DataFormatManager
  - setDataFormatManager
```
public void setDataFormatManager(DataFormatManager dataFormatManager)
```
    Specifies the pivot table's DataFormatManager.
    
    Parameters:
    dataFormatManager - the pivot table's DataFormatManager
  - getHeaderFormatManager
```
public HeaderFormatManager getHeaderFormatManager()
```
    Retrieves the pivot table's HeaderFormatManager.
    
    Returns:
    the pivot table's HeaderFormatManager
  - setHeaderFormatManager
```
public void setHeaderFormatManager(HeaderFormatManager headerFormatManager)
```
    Specifies the pivot table's HeaderFormatManager.
    
    Parameters:
    headerFormatManager - the pivot table's HeaderFormatManager
  - getDataFormat
```
public javax.el.MethodExpression getDataFormat()
```
    Retrieves the pivot table's data cell CellFormat MethodExpression. When dataFormat is specified, it overrides the built-in or application-specified DataFormatManager.
    
    Returns:
    the pivot table's data cell CellFormat MethodExpression
  - setDataFormat
```
public void setDataFormat(javax.el.MethodExpression dataFormat)
```
    Specifies the pivot table's data cell CellFormat MethodExpression. When dataFormat is specified, it overrides the built-in or application-specified DataFormatManager.
    
    Parameters:
    dataFormat - the pivot table's data cell CellFormat MethodExpression
  - getHeaderFormat
```
public javax.el.MethodExpression getHeaderFormat()
```
    Retrieves the pivot table's header cell CellFormat MethodExpression. When headerFormat is specified, it overrides the built-in or application-specified HeaderFormatManager.
    
    Returns:
    the pivot table's header cell CellFormat MethodExpression
  - setHeaderFormat
```
public void setHeaderFormat(javax.el.MethodExpression headerFormat)
```
    Specifies the pivot table's header cell CellFormat MethodExpression. When headerFormat is specified, it overrides the built-in or application-specified HeaderFormatManager.
    
    Parameters:
    headerFormat - the pivot table's header cell CellFormat MethodExpression
  - getInlineStyle
```
public java.lang.String getInlineStyle()
```
    Retrieves the pivot table's outer element's inline style, which can be used for sizing/positioning the pivot table.
    
    Returns:
    the pivot table's inline style
  - setInlineStyle
```
public void setInlineStyle(java.lang.String inlineStyle)
```
    Specifies the pivot table's outer element's inline style, which can be used for sizing/positioning the pivot table.
    
    Parameters:
    inlineStyle - the pivot table's inline style
  - getStyleClass
```
public java.lang.String getStyleClass()
```
    Retrieves the CSS style class to use for this component.
    
    Returns:
    the pivot table's style class
  - setStyleClass
```
public void setStyleClass(java.lang.String styleClass)
```
    Sets a CSS style class to use for this component.
    
    Parameters:
    styleClass - the pivot table's style class
  - getSummary
```
public java.lang.String getSummary()
```
    Retrieves a summary of this pivot table's purpose and structure for user agents rendering to non-visual media / screen readers.
    
    Returns:
    a summary of this pivot table's purpose and structure
  - setSummary
```
public void setSummary(java.lang.String summary)
```
    Sets a summary of this pivot table's purpose and structure for user agents rendering to non-visual media / screen readers.
    
    Parameters:
    summary - a summary of this pivot table's purpose and structure
  - getEmptyText
```
public java.lang.String getEmptyText()
```
    Retrieves the text shown in an empty pivot table, that is, a pivot table having 0 rows or columns. If the text is enclosed in an html tag, it will be formatted. The formatting behavior is similar to the outputFormatted component.
    
    Returns:
    the text to show in an empty pivot table
  - setEmptyText
```
public void setEmptyText(java.lang.String emptyText)
```
    Sets the text shown in an empty pivot table, that is, a pivot table having 0 rows or columns. If the text is enclosed in an html tag, it will be formatted. The formatting behavior is similar to the outputFormatted component.
    
    Parameters:
    emptyText - the text to show in an empty pivot table
  - getContentDelivery
```
public java.lang.String getContentDelivery()
```
    Retrieves whether the content of the pivot table is delivered immediately or lazily. Valid values are CONTENT_DELIVERY_LAZY, CONTENT_DELIVERY_IMMEDIATE, and CONTENT_DELIVERY_WHEN_AVAILABLE. If CONTENT_DELIVERY_LAZY, then the pivot table's content is fetched after the pivot table is sent to the user agent / browser. If CONTENT_DELIVERY_IMMEDIATE, then the pivot table content is immediately sent to the user agent / browser. If CONTENT_DELIVERY_WHEN_AVAILABLE, then the pivot table content is sent immediately if and only if the data is readily available. The default value is CONTENT_DELIVERY_WHEN_AVAILABLE.
    
    Returns:
    the pivot table's content delivery mode
  - setContentDelivery
```
public void setContentDelivery(java.lang.String contentDelivery)
```
    Specifies whether the content of the pivot table is delivered immediately or lazily. Valid values are CONTENT_DELIVERY_LAZY, CONTENT_DELIVERY_IMMEDIATE, and CONTENT_DELIVERY_WHEN_AVAILABLE. If CONTENT_DELIVERY_LAZY, then the pivot table's content is fetched after the pivot table is sent to the user agent / browser. If CONTENT_DELIVERY_IMMEDIATE, then the pivot table content is immediately sent to the user agent / browser. If CONTENT_DELIVERY_WHEN_AVAILABLE, then the pivot table content is sent immediately if and only if the data is readily available. The default value is CONTENT_DELIVERY_WHEN_AVAILABLE.
    
    Parameters:
    contentDelivery - the pivot table's content delivery mode
  - getCustomizationId
```
@Deprecated
public final java.lang.String getCustomizationId()
```
    Deprecated. The id attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
    
    Returns:
    the customization ID
  - setCustomizationId
```
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
```
    Deprecated. The id attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
    
    Parameters:
    customizationId - the new customization ID
  - getPersist
```
public final java.lang.String[] getPersist()
```
    Gets a list of persistent attributes that are persisted to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.
    
    Returns:
    an array of persistent attributes
  - setPersist
```
public final void setPersist(java.lang.String[] persist)
```
    Sets a list of persistent attributes that are persisted to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.
    
    Parameters:
    persist - a list of persistent attributes
  - getDontPersist
```
public final java.lang.String[] getDontPersist()
```
    Gets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.
    
    Returns:
    an array of non-persistent attributes
  - setDontPersist
```
public final void setDontPersist(java.lang.String[] dontPersist)
```
    Sets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.
    
    Parameters:
    dontPersist - a list of non-persistent attributes
  - getClientListeners
```
public final oracle.adf.view.rich.event.ClientListenerSet getClientListeners()
```
    Gets a set of client listeners.
    
    Returns:
    a set of client listeners
  - setClientListeners
```
public final void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)
```
    Sets a set of client listeners.
    
    Parameters:
    clientListeners - a set of client listeners
  - getContextMenuId
```
@Deprecated
public final java.lang.String getContextMenuId()
```
    Deprecated. Use the contextMenu facet instead.
    
    Gets a search expression to identify the popup component containing the context menu that will be shown for right-clicks within selectable regions of the pivot table, such as the row header, column header, or databody. Expressions are relative to this pivot table component and must account for NamingContainers. You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will search from the parent NamingContainer, ":::" will search from the grandparent NamingContainer, etc.
    
    Returns:
    the context menu ID
  - setContextMenuId
```
@Deprecated
public final void setContextMenuId(java.lang.String contextMenuId)
```
    Deprecated. Use the contextMenu facet instead.
    
    Sets a search expression to identify the popup component containing the context menu that will be shown for right-clicks within selectable regions of the pivot table, such as the row header, column header, or databody. Expressions are relative to this pivot table component and must account for NamingContainers. You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will search from the parent NamingContainer, ":::" will search from the grandparent NamingContainer, etc.
    
    Parameters:
    contextMenuId - the new context menu ID
  - getBodyContextMenuId
```
@Deprecated
public final java.lang.String getBodyContextMenuId()
```
    Deprecated. Use the bodyContextMenu facet instead.
    
    Gets a search expression to identify the popup component containing the context menu that will be shown within the pivot table body, for right-clicks within selectable regions of the pivot table, such as the row header, column header, or databody. Expressions are relative to this pivot table component and must account for NamingContainers. You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will search from the parent NamingContainer, ":::" will search from the grandparent NamingContainer, etc.
    
    Returns:
    the body context menu ID
  - setBodyContextMenuId
```
@Deprecated
public final void setBodyContextMenuId(java.lang.String bodyContextMenuId)
```
    Deprecated. Use the bodyContextMenu facet instead.
    
    Sets a search expression to identify the popup component containing the context menu that will be shown within the pivot table body, for right-clicks within selectable regions of the pivot table, such as the row header, column header, or databody. Expressions are relative to this pivot table component and must account for NamingContainers. You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will search from the parent NamingContainer, ":::" will search from the grandparent NamingContainer, etc.
    
    Parameters:
    bodyContextMenuId - the new body context menu ID
  - getSizing
```
public final java.lang.String getSizing()
```
    Retrieves how the pivot table's size ( width/height ) is determined. Valid values are "fixed" or "auto". The default value is "fixed".
    When sizing="fixed", either the pivot table is sized by its parent (if the parent stretches its children) or its width and height are the values computed from the skin, styleClass, and inlineStyle (if the parent does not stretch its children).
    When sizing="auto" and the parent stretches its children, "auto" is ignored and the pivot table is sized as in the "fixed" case above.
    When sizing="auto" and the parent does not stretch its children, the pivot table will shrink to the size of its content if the content is smaller than the pivot table. Specifically:
    - Pivot Table width = min(content width, default width )
    - Pivot Table height = min(content height, default height)
    where "default width" and "default height" are the width and height computed from the skin, styleClass, and inlineStyle.
    Please note that when sizing="auto", the pivot table's frame will initially be displayed with the default size of the pivot table ( as defined above ) and then the pivot table's frame will readjust to fit its contents. This can cause the layout of the page displaying the pivot table to change after the page is initially displayed.
    Returns:
    either "fixed" or "auto"
  - setSizing
```
public final void setSizing(java.lang.String sizing)
```
    Specifies how the pivot table's size ( width/height ) is determined. Valid values are "fixed" or "auto". The default value is "fixed".
    When sizing="fixed", either the pivot table is sized by its parent (if the parent stretches its children) or its width and height are the values computed from the skin, styleClass, and inlineStyle (if the parent does not stretch its children).
    When sizing="auto" and the parent stretches its children, "auto" is ignored and the pivot table is sized as in the "fixed" case above.
    When sizing="auto" and the parent does not stretch its children, the pivot table will shrink to the size of its content if the content is smaller than the pivot table. Specifically:
    - Pivot Table width = min(content width, default width )
    - Pivot Table height = min(content height, default height)
    where "default width" and "default height" are the width and height computed from the skin, styleClass, and inlineStyle.
    Please note that when sizing="auto", the pivot table's frame will initially be displayed with the default size of the pivot table ( as defined above ) and then the pivot table's frame will readjust to fit its contents. This can cause the layout of the page displaying the pivot table to change after the page is initially displayed.
    Parameters:
    sizing - either "fixed" or "auto"
  - getModelName
```
public java.lang.String getModelName()
```
    Retrieves the model name of the Pivot Table. The model name is used to ensure that pivoting can only be done with a PivotFilterBar with the same model name. If the model name is not specified then it can work with any PivotFilterBar.
    
    Returns:
    the model name of the Pivot Table
  - setModelName
```
public void setModelName(java.lang.String modelName)
```
    Specifies the model name of the Pivot Table. The model name is used to ensure that pivoting can only be done with a PivotFilterBar with the same model name. If the model name is not specified then it can work with any PivotFilterBar.
  - getActiveCellKey
```
public CellKey getActiveCellKey()
```
    Retrieves the active cell key of the Pivot Table. An active cell in Pivot Table will be made editable and is brought into view (if not already visible). If active cell key is not specified, then the Pivot Table defaults the active cell to the first visible cell.
    
    Returns:
    the active cell key of the Pivot Table
  - setActiveCellKey
```
public void setActiveCellKey(CellKey activeCellKey)
```
    Specifies the active cell key of the Pivot Table. An active cell in Pivot Table will be made editable and is brought into view (if not already visible). If active cell key is not specified, then the Pivot Table defaults the active cell to the first visible cell.
  - getScrollPolicy
```
public final java.lang.String getScrollPolicy()
```
    Gets the mechanism used to scroll data within the Pivot Table. Possible values are: auto (depends on your device), page, and scroll.
    
    Returns:
    the scrollPolicy value
  - setScrollPolicy
```
public final void setScrollPolicy(java.lang.String scrollPolicy)
```
    Sets the mechanism used to scroll data within the Pivot Table. Possible values are: auto (depends on your device), page, and scroll.
    
    Parameters:
    scrollPolicy - the new scrollPolicy value
  - setClientBlocks
```
public void setClientBlocks(java.util.List<DataBlock> clientBlocks)
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - getClientBlocks
```
public java.util.List<DataBlock> getClientBlocks()
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - cleanClientKeyManager
```
public void cleanClientKeyManager()
```
    For internal use only.
    
    For internal use only. Application developers should not use this
  - cleanStampState
```
public void cleanStampState()
```
    For internal use only. Checks which blocks are on the client and clears the cells that are no longer on the client.
    
    For internal use only. Application developers should not use this
  - visitChildren
```
protected boolean visitChildren(javax.faces.component.visit.VisitContext visitContext,
                    javax.faces.component.visit.VisitCallback callback)
```
    Overrides:
    
    visitChildren in class org.apache.myfaces.trinidad.component.UIXComponent
  - defaultVisitChildren
```
protected final boolean defaultVisitChildren(javax.faces.component.visit.VisitContext visitContext,
                           javax.faces.component.visit.VisitCallback callback)
```
  - visitData
```
protected boolean visitData(javax.faces.component.visit.VisitContext visitContext,
                javax.faces.component.visit.VisitCallback visitCallback)
```
  - getDefaultEventName
```
public java.lang.String getDefaultEventName()
```
    Gets the default event name.
    
    Specified by:
    
    getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase
    
    Returns:
    the default event name
  - getEventNames
```
public java.util.Collection<java.lang.String> getEventNames()
```
    Gets the names of all the events supported by this component.
    
    Specified by:
    
    getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Returns:
    the names of all the events supported by this component
  - getClientBehaviors
```
public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
```
    Gets the client behaviors for this component.
    
    Specified by:
    
    getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase
    
    Returns:
    the client behaviors for this component
  - addClientBehavior
```
public void addClientBehavior(java.lang.String eventName,
                     javax.faces.component.behavior.ClientBehavior behavior)
```
    Gets the client behaviors for this component.
    
    Specified by:
    
    addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase
    
    Parameters:
    eventName - the name of the event
    behavior - the client behavior to add

Class UIPivotTable

Pivot Table Features

Pivot Table Model

Sizing

Customizing Cell Content

Selection

Drill

Pivot

Sort

Split Panes

Status Bar

Geometry Management

Accessibility Guideline(s)

Supported Client Events for Client Behaviors

Child Tags

Example

Nested Class Summary

Nested classes/interfaces inherited from class oracle.adf.view.faces.bi.component.pivotTable.UIGrid

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

Field Summary

Fields inherited from class oracle.adf.view.faces.bi.component.pivotTable.UIGrid

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

Fields inherited from class javax.faces.component.UIComponent

Fields inherited from interface javax.faces.component.NamingContainer

Constructor Summary

Method Summary

Methods inherited from class oracle.adf.view.faces.bi.component.pivotTable.UIGrid

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Field Detail

TYPE

VALUE_KEY

PARTIAL_TRIGGERS_KEY

DRILLING_ENABLED_KEY

DRILL_REQUESTING_LISTENER_KEY

DRILL_REQUESTED_LISTENER_KEY

SORT_LISTENER_KEY

SPLIT_LISTENER_KEY

PIVOT_LISTENER_KEY

DRILL_ACTION_KEY

AUTOINDENT_KEY

INDENT_ENABLED_KEY

LAYER_LABEL_MODE_KEY

PIVOT_LABEL_VISIBLE_KEY

PIVOT_ENABLED_KEY

SORT_MODE_KEY

HEADER_SORT_MODE_KEY

START_ROW_KEY

START_COLUMN_KEY

SECOND_START_ROW_KEY

SECOND_START_COLUMN_KEY

SPLIT_ROW_KEY

SPLIT_COLUMN_KEY

SPLIT_MODE_KEY

ROW_HEADER_START_LAYER_KEY

COLUMN_HEADER_START_LAYER_KEY

START_ROW_PIXEL_KEY

START_COLUMN_PIXEL_KEY

SECOND_START_ROW_PIXEL_KEY

SECOND_START_COLUMN_PIXEL_KEY

ROW_HEADER_START_PIXEL_KEY

COLUMN_HEADER_START_PIXEL_KEY

HEADER_FORMAT_KEY

DATA_FORMAT_KEY

INLINE_STYLE_KEY

SIZING_MANAGER_KEY

SELECTION_KEY

STATUS_BAR_RENDERED_KEY

DATA_FORMAT_MANAGER_KEY

HEADER_FORMAT_MANAGER_KEY

CONTENT_DELIVERY_KEY

COLUMN_FETCH_SIZE_KEY

ROW_FETCH_SIZE_KEY

PREFERRED_COLUMN_HEADER_HEIGHT_KEY

PREFERRED_ROW_HEADER_WIDTH_KEY

CLIENT_LISTENERS_KEY

CELL_IMAGE_CLICK_LISTENER_KEY

CELL_IMAGE_CLICK_ACTION_KEY