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.
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.
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.
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:
javax.faces.convert.Converter, which is used to perform number/date/text formatting of a cell raw value For more detailed description, refer to <dvt:dataCell> component guide
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 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 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.
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.
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.
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.
sizingManager attribute for more information.sizing attribute.
summary attribute:The summary property must be specified. The summary should describe the purpose of the component.
|
|
|
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
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}"
/>
| 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.
|
UIGrid.DefaultClientKeyManager, UIGrid.NullCellKey| 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 |
RANGE_CHANGE_LISTENER_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 java.lang.String |
VALUE_SUBMIT_POLICY_IMMEDIATE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VALUE_SUBMIT_POLICY_KEY |
static java.lang.String |
VALUE_SUBMIT_POLICY_LAZY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VAR_STATUS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY| Constructor and Description |
|---|
UIPivotTable()
Constructs a new Pivot Table.
|
| 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 |
addRangeChangeListener(RangeChangeListener listener)
Adds a range change 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.
|
javax.el.MethodExpression |
getRangeChangeListener()
Gets the range change listener.
|
RangeChangeListener[] |
getRangeChangeListeners()
Gets the range change listeners.
|
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 |
getValueSubmitPolicy()
Gets the behavior of when value(s) are submitted to the server when user navigates between cells.
|
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 |
removeRangeChangeListener(RangeChangeListener listener)
Removes the specified range change 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 |
setRangeChangeListener(javax.el.MethodExpression rangeChangeListener)
Sets the range change listener.
|
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 |
setValueSubmitPolicy(java.lang.String valueSubmitPolicy)
Sets the behavior of which when value(s) are submitted to the server when user navigates between cells.
|
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) |
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, validateChildrenImpladaptMethodBinding, 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, getPassThroughAttributes, 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, validateChildrenaddPartialTarget, 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, visitTreeencodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInViewpublic static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DRILLING_ENABLED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DRILL_REQUESTING_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DRILL_REQUESTED_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SORT_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SPLIT_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PIVOT_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey RANGE_CHANGE_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DRILL_ACTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTOINDENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INDENT_ENABLED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LAYER_LABEL_MODE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PIVOT_LABEL_VISIBLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PIVOT_ENABLED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SORT_MODE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_SORT_MODE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey START_ROW_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey START_COLUMN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SECOND_START_ROW_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SECOND_START_COLUMN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SPLIT_ROW_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SPLIT_COLUMN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SPLIT_MODE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_HEADER_START_LAYER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_HEADER_START_LAYER_KEY
@Concealed public static final org.apache.myfaces.trinidad.bean.PropertyKey START_ROW_PIXEL_KEY
@Concealed public static final org.apache.myfaces.trinidad.bean.PropertyKey START_COLUMN_PIXEL_KEY
@Concealed public static final org.apache.myfaces.trinidad.bean.PropertyKey SECOND_START_ROW_PIXEL_KEY
@Concealed public static final org.apache.myfaces.trinidad.bean.PropertyKey SECOND_START_COLUMN_PIXEL_KEY
@Concealed public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_HEADER_START_PIXEL_KEY
@Concealed public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_HEADER_START_PIXEL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_FORMAT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DATA_FORMAT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SIZING_MANAGER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STATUS_BAR_RENDERED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DATA_FORMAT_MANAGER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_FORMAT_MANAGER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_FETCH_SIZE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_FETCH_SIZE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PREFERRED_COLUMN_HEADER_HEIGHT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PREFERRED_ROW_HEADER_WIDTH_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_SUBMIT_POLICY_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CELL_IMAGE_CLICK_LISTENER_KEY
<dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CELL_IMAGE_CLICK_ACTION_KEY
<dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SUMMARY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VAR_STATUS_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTEXT_MENU_ID_KEY
contextMenu facet instead.@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey BODY_CONTEXT_MENU_ID_KEY
bodyContextMenu facet instead.public static final org.apache.myfaces.trinidad.bean.PropertyKey SIZING_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MODEL_NAME_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTIVE_CELL_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_POLICY_KEY
@Concealed public static final org.apache.myfaces.trinidad.bean.PropertyKey SHRINK_TO_FIT_KEY
@Concealed public static final org.apache.myfaces.trinidad.bean.PropertyKey DATA_CELL_CONTENT_KEY
@Concealed public static final org.apache.myfaces.trinidad.bean.PropertyKey DEFAULT_GRAPH_KEY
@Concealed public static final org.apache.myfaces.trinidad.bean.PropertyKey GRAPH_SCREENREADER_MODE
public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE
public static final java.lang.String CONTENT_DELIVERY_LAZY
public static final java.lang.String CONTENT_DELIVERY_WHEN_AVAILABLE
public static final java.lang.String SCROLL_POLICY_AUTO
public static final java.lang.String SCROLL_POLICY_PAGE
public static final java.lang.String SCROLL_POLICY_SCROLL
public static final java.lang.String SORT_MODE_GROUPED
public static final java.lang.String SORT_MODE_UNGROUPED
public static final java.lang.String SORT_MODE_NONE
public static final java.lang.String SPLIT_MODE_ENABLED
public static final java.lang.String SPLIT_MODE_DISABLED
public static final java.lang.String LAYER_LABEL_MODE_RENDERED
public static final java.lang.String LAYER_LABEL_MODE_HIDDEN
public static final java.lang.String CONTEXT_MENU_FACET
public static final java.lang.String BODY_CONTEXT_MENU_FACET
public static final java.lang.String VALUE_SUBMIT_POLICY_IMMEDIATE
public static final java.lang.String VALUE_SUBMIT_POLICY_LAZY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
@Concealed public static final java.lang.String PIVOTTABLE_NAME
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBasepublic void setPartialTriggers(java.lang.String[] ids)
ids - the partial triggerspublic java.lang.String[] getPartialTriggers()
public final javax.el.MethodExpression getDrillRequestingListener()
public final void setDrillRequestingListener(javax.el.MethodExpression drillRequestingListener)
drillRequestingListener - the "before drill" listenerpublic final javax.el.MethodExpression getDrillRequestedListener()
public final void setDrillRequestedListener(javax.el.MethodExpression drillRequestedListener)
drillRequestedListener - the "after drill" listenerpublic final javax.el.MethodExpression getDrillAction()
public final void setDrillAction(javax.el.MethodExpression drillAction)
drillAction - the drill actionpublic void queueEvent(javax.faces.event.FacesEvent e)
queueEvent in class UIGride - the event to queuepublic void addDrillListener(DrillListener listener)
listener - the drill listener to addpublic void removeDrillListener(DrillListener listener)
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.public DrillListener[] getDrillListeners()
protected void sort(SortEvent.SortType type, java.util.Map<java.lang.String,java.lang.Object> properties)
type - the type of sort, for example a column sortproperties - conveys details like the column number, sort direction, and so onpublic void addSortListener(SortListener listener)
listener - the sort listener to addpublic void removeSortListener(SortListener listener)
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.public SortListener[] getSortListeners()
public final void setSortListener(javax.el.MethodExpression sortListener)
sortListener - the sort listenerpublic final javax.el.MethodExpression getSortListener()
public void addSplitListener(SplitListener listener)
listener - the split listener to addpublic void removeSplitListener(SplitListener listener)
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.public SplitListener[] getSplitListeners()
public final void setSplitListener(javax.el.MethodExpression splitListener)
splitListener - the split listenerpublic final javax.el.MethodExpression getSplitListener()
public void addPivotListener(PivotListener listener)
listener - the pivot listener to addpublic void removePivotListener(PivotListener listener)
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.public PivotListener[] getPivotListeners()
public final void setPivotListener(javax.el.MethodExpression pivotListener)
pivotListener - the pivot listenerpublic final javax.el.MethodExpression getPivotListener()
public void addRangeChangeListener(RangeChangeListener listener)
listener - the range change listener to addpublic void removeRangeChangeListener(RangeChangeListener listener)
removeRangeChangeListener must not be called with the same listener
object that was passed to addRangeChangeListener. Due to component state
saving and restoring, the actual listener objects on this list will
vary. Call getRangeChangeListeners to get the current list of listener
objects.public RangeChangeListener[] getRangeChangeListeners()
public final void setRangeChangeListener(javax.el.MethodExpression rangeChangeListener)
rangeChangeListener - the range change listenerpublic final javax.el.MethodExpression getRangeChangeListener()
@Deprecated public void addCellImageClickListener(CellImageClickListener listener)
<dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.@Deprecated public void removeCellImageClickListener(CellImageClickListener listener)
<dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.@Deprecated public final javax.el.MethodExpression getCellImageClickListener()
<dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.@Deprecated public CellImageClickListener[] getCellImageClickListeners()
<dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.@Deprecated public final void setCellImageClickListener(javax.el.MethodExpression cellImageClickListener)
<dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.@Deprecated public final javax.el.MethodExpression getCellImageClickAction()
<dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.@Deprecated public final void setCellImageClickAction(javax.el.MethodExpression cellImageClickAction)
<dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead.@Concealed public javax.faces.el.MethodBinding getAction()
getAction in interface javax.faces.component.ActionSource@Concealed public void setAction(javax.faces.el.MethodBinding action)
setAction in interface javax.faces.component.ActionSource@Concealed public javax.el.MethodExpression getActionExpression()
getActionExpression in interface javax.faces.component.ActionSource2@Concealed public void setActionExpression(javax.el.MethodExpression action)
setActionExpression in interface javax.faces.component.ActionSource2@Concealed public javax.faces.el.MethodBinding getActionListener()
getActionListener in interface javax.faces.component.ActionSource@Concealed public void setActionListener(javax.faces.el.MethodBinding listener)
setDrillListener, setPivotListener, etc.setActionListener in interface javax.faces.component.ActionSource@Concealed public void addActionListener(javax.faces.event.ActionListener listener)
addDrillListener, addPivotListener, etc.addActionListener in interface javax.faces.component.ActionSource@Concealed public void removeActionListener(javax.faces.event.ActionListener listener)
removeDrillListener, removePivotListener, etc.removeActionListener in interface javax.faces.component.ActionSource@Concealed public javax.faces.event.ActionListener[] getActionListeners()
getActionListeners in interface javax.faces.component.ActionSourcepublic boolean isImmediate()
false.isImmediate in interface javax.faces.component.ActionSourcefalsepublic void setImmediate(boolean immediate)
setImmediate in interface javax.faces.component.ActionSourceimmediate - ignoredpublic UIPivotTable.ActionType getActionType()
public void setActionType(UIPivotTable.ActionType actionType)
actionType - protected void drill(DrillEvent drillEvent)
drillEvent - specifies the header cell to drill and the drill typeprotected void setStartAndSplitSliceAfterDrill(DrillEvent drillEvent, QDR drilledMemberQdr)
drillEvent - specifies the header cell to drill and the drill typedrilledMemberQdr - QDR of the header cell that was drilledpublic void broadcast(javax.faces.event.FacesEvent event)
throws javax.faces.event.AbortProcessingException
UIGridprotected void fireEventToAppListener(javax.faces.context.FacesContext context,
javax.faces.event.FacesEvent event)
context - the Faces Contextevent - the event to firepublic final void setValue(java.lang.Object value)
DataModel.value - the data modelpublic final java.lang.Object getValue()
DataModel.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.
b - true to enable drilling,
false to disable drillingpublic 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.
true if drilling is enabled,
false if drilling is disabled@Concealed public java.lang.Object getLocalValue()
public DataModel createDataModel(DataModel current, java.lang.Object value)
DataModel.createDataModel in class UIGridcurrent - the current DataModel, or null if there is none.value - this is the value returned from UIGrid.getValue()protected java.util.Map<java.lang.String,java.lang.Object> createVarStatusMap()
createVarStatusMap in class UIGridpublic CellFormat getCellFormat()
CellFormat for the current cell.CellFormat for the current cellpublic java.lang.Object getRawValue()
public javax.faces.component.UIComponent getCellComponent()
public java.util.List<javax.faces.component.UIComponent> getStamps()
protected UIHeaderCell getHeaderCell()
UIHeaderCell for this Pivot Table.UIHeaderCell for this Pivot Tableprotected UIDataCell getDataCell(java.lang.String dataAttribute)
UIDataCell for this Pivot Table.
Note: dataAttribute has been deprecated. Users should use a switcher instead.dataAttribute - deprecated. Please use a switcher instead of this parameter.UIDataCell for this Pivot Tableprotected java.util.List<javax.faces.component.UIComponent> getStamps(UIHeaderCell headerCell)
headerCell - the header cellprotected java.util.List<javax.faces.component.UIComponent> getStamps(UIDataCell dataCell)
dataCell - the data cellprotected void resetStamps()
@Concealed public java.lang.Object getCurrentCellContext()
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)
CellFormat for the header cell indicated by the parameters.context - the Faces ContextheaderFormat - the headerFormat method expressionheaderFormatManager - the HeaderFormatManagermodel - the DataModeledge - the edge of the header cell, either DataDirector.COLUMN_EDGE or DataDirector.ROW_EDGElayer - the layer of the header cellslice - the slice of the header cellqdr - the QDR of the header cellvalue - the value in the header cellCellFormat for the header cellprotected 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)
CellFormat for the data cell indicated by the parameters.context - the Faces ContextdataFormat - the dataFormat method expressiondataFormatManager - the DataFormatManagermodel - the DataModelrow - the row of the data cellcolumn - the column of the data cellqdr - the QDR of the data cellvalue - the value in the data cellCellFormat for the data cellprotected void postCellDataChange()
UIGridpostCellDataChange in class UIGridprotected java.lang.String getMeasureName(QDR qdr)
QDR.qdr - QDRprotected void processFacetsAndChildren(javax.faces.context.FacesContext context,
javax.faces.event.PhaseId phaseId)
UIGridUIGrid.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.processFacetsAndChildren in class UIGridcontext - the Faces ContextphaseId - the phase IDpublic final java.lang.String getVarStatus()
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:DataModel for the pivot tablegetVarStatus in class UIGridvarStatus valueUIGrid.createVarStatusMap()public final void setVarStatus(java.lang.String varStatus)
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:DataModel for the pivot tablevarStatus - the new varStatus valuepublic final SizingManager getSizingManager()
SizingManager instance that controls overrides for row heights, column widths,
row header column widths, and column header row heights.SizingManager instancepublic final void setSizingManager(SizingManager sizing)
SizingManager instance that controls overrides for row heights, column widths,
row header column widths, and column header row heights.sizing - a SizingManager instancepublic final Selection getSelection()
Selection instance that indicates which data cells and header cells
are selected in the pivot table.Selection instancepublic final void setSelection(Selection selection)
Selection instance that indicates which data cells and header cells
are selected in the pivot table.selection - a Selection instancepublic final boolean isStatusBarRendered()
boolean indicating whether the status bar is rendered in the
pivot table. By default, it is not rendered.true if the status bar is rendered, false otherwisepublic final void setStatusBarRendered(boolean rendered)
rendered - true to render the status bar, false otherwisepublic java.lang.String getFamily()
rendererType property, may be used to select
the appropriate Renderer for this component instance.getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBasepublic 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.
r - the index of the first row to be scrolled into viewpublic int getStartRow()
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.
c - the index of the first column to be scrolled into viewpublic int getStartColumn()
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.
r - the index of the first row to be scrolled into view in the bottom panepublic int getSecondStartRow()
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.
c - the index of the first column to be scrolled into view in the second panepublic int getSecondStartColumn()
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:
splitRow-1) can be viewed in the top pane, and rows splitRow to (rowExtent-1) can be viewed in the bottom pane.0 &le startRow < splitRow &le secondStartRow < rowExtent.
This ensures that each pane is non-empty and contains a valid startRow.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.
r - the index of the row at which panes should be split, satisfying 0 < r < rowExtent, or -1 to indicate no row splitpublic int getSplitRow()
Gets the splitRow attribute. If panes are split so that there is both a top and bottom databody pane, then:
splitRow-1) can be viewed in the top pane, and rows splitRow to (rowExtent-1) can be viewed in the bottom pane.0 &le startRow < splitRow &le secondStartRow < rowExtent.
This ensures that each pane is non-empty and contains a valid startRow.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.
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:
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.
c - the index of the column at which panes should be split, satisfying 0 < c < columnExtent, or -1 to indicate no column splitpublic int getSplitColumn()
Sets the splitColumn attribute. If panes are split so that there is both a left and right databody pane, then:
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.
public java.lang.String getSplitMode()
UIPivotTable.SPLIT_MODE_ENABLED and UIPivotTable.SPLIT_MODE_DISABLED.
The default value is UIPivotTable.SPLIT_MODE_DISABLED.public void setSplitMode(java.lang.String splitMode)
UIPivotTable.SPLIT_MODE_ENABLED and UIPivotTable.SPLIT_MODE_DISABLED.
The default value is UIPivotTable.SPLIT_MODE_DISABLED.splitMode - the split modepublic 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.
layer - the index of the first layer to displaypublic 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."
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.
layer - the index of the first layer to displaypublic 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."
public void setRowFetchSize(int rowFetchSize)
rowFetchSize - the number of rows to fetch in each pivot table block that is downloaded to the user agent / browserpublic int getRowFetchSize()
public void setColumnFetchSize(int columnFetchSize)
columnFetchSize - the number of columns to fetch in each pivot table block that is downloaded to the user agent / browserpublic int getColumnFetchSize()
public void setPreferredRowHeaderWidth(java.lang.String preferredWidth)
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.
preferredWidth - the preferred width of the row header, e.g "40%"public java.lang.String getPreferredRowHeaderWidth()
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.
public void setPreferredColumnHeaderHeight(java.lang.String preferredHeight)
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.
preferredHeight - the preferred height of the column header, e.g "40%"public java.lang.String getPreferredColumnHeaderHeight()
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.
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.
LAYER_LABEL_MODE_RENDERED if layer/dimension names are rendered,
LAYER_LABEL_MODE_HIDDEN if they are notpublic 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.
layerLabelMode - LAYER_LABEL_MODE_RENDERED to render layer/dimension names,
LAYER_LABEL_MODE_HIDDEN to prevent rendering thempublic boolean isPivotLabelVisible()
true if layer/dimension names are visible on pivot handles,
false if they are notpublic void setPivotLabelVisible(boolean visible)
visible - true to display layer/dimension names on pivot handles,
false to prevent their displaypublic 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.
true if pivoting is enabled,
false if pivoting is disabledpublic void setPivotEnabled(boolean enabled)
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.
enabled - true if pivoting is enabled,
false if pivoting is disabledpublic java.lang.String getSortMode()
UIPivotTable.SORT_MODE_GROUPED, UIPivotTable.SORT_MODE_UNGROUPED, or UIPivotTable.SORT_MODE_NONE.
The default value is UIPivotTable.SORT_MODE_GROUPED.public void setSortMode(java.lang.String sortMode)
UIPivotTable.SORT_MODE_GROUPED, UIPivotTable.SORT_MODE_UNGROUPED, or UIPivotTable.SORT_MODE_NONE.
The default value is UIPivotTable.SORT_MODE_GROUPED.sortMode - the sort modepublic java.lang.String getHeaderSortMode()
UIPivotTable.SORT_MODE_GROUPED or UIPivotTable.SORT_MODE_NONE.
The default value is UIPivotTable.SORT_MODE_GROUPED.public void setHeaderSortMode(java.lang.String headerSortMode)
UIPivotTable.SORT_MODE_GROUPED or UIPivotTable.SORT_MODE_NONE.
The default value is UIPivotTable.SORT_MODE_GROUPED.headerSortMode - the header sort modepublic void setIndentEnabled(boolean b)
b - true to indent labels,
false to align all the labelspublic boolean isIndentEnabled()
true if row labels are indented,
false if they are all alignedpublic void setVisible(boolean visible)
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.visible - true if the component is visible,
false if the component isn't visiblepublic boolean isVisible()
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.true if the component is visible,
false if the component isn't visiblepublic void setAutoIndent(int i)
i - the number of pixels to indent each levelpublic int getAutoIndent()
public DataFormatManager getDataFormatManager()
DataFormatManager.DataFormatManagerpublic void setDataFormatManager(DataFormatManager dataFormatManager)
DataFormatManager.dataFormatManager - the pivot table's DataFormatManagerpublic HeaderFormatManager getHeaderFormatManager()
HeaderFormatManager.HeaderFormatManagerpublic void setHeaderFormatManager(HeaderFormatManager headerFormatManager)
HeaderFormatManager.headerFormatManager - the pivot table's HeaderFormatManagerpublic javax.el.MethodExpression getDataFormat()
CellFormat MethodExpression.
When dataFormat is specified, it overrides the built-in or application-specified
DataFormatManager.CellFormat MethodExpressionpublic void setDataFormat(javax.el.MethodExpression dataFormat)
CellFormat MethodExpression.
When dataFormat is specified, it overrides the built-in or application-specified
DataFormatManager.dataFormat - the pivot table's data cell CellFormat MethodExpressionpublic javax.el.MethodExpression getHeaderFormat()
CellFormat MethodExpression.
When headerFormat is specified, it overrides the built-in or application-specified
HeaderFormatManager.CellFormat MethodExpressionpublic void setHeaderFormat(javax.el.MethodExpression headerFormat)
CellFormat MethodExpression.
When headerFormat is specified, it overrides the built-in or application-specified
HeaderFormatManager.headerFormat - the pivot table's header cell CellFormat MethodExpressionpublic java.lang.String getInlineStyle()
public void setInlineStyle(java.lang.String inlineStyle)
inlineStyle - the pivot table's inline stylepublic java.lang.String getStyleClass()
public void setStyleClass(java.lang.String styleClass)
styleClass - the pivot table's style classpublic java.lang.String getSummary()
public void setSummary(java.lang.String summary)
summary - a summary of this pivot table's purpose and structurepublic java.lang.String getEmptyText()
outputFormatted component.public void setEmptyText(java.lang.String emptyText)
outputFormatted component.emptyText - the text to show in an empty pivot tablepublic java.lang.String getContentDelivery()
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.public void setContentDelivery(java.lang.String contentDelivery)
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.contentDelivery - the pivot table's content delivery mode@Deprecated public final java.lang.String getCustomizationId()
id attribute should be used when applying persistent customizations.
This attribute will be removed in the next release.@Deprecated public final void setCustomizationId(java.lang.String customizationId)
id attribute should be used when applying persistent customizations.
This attribute will be removed in the next release.customizationId - the new customization IDpublic final java.lang.String[] getPersist()
public final void setPersist(java.lang.String[] persist)
persist - a list of persistent attributespublic final java.lang.String[] getDontPersist()
public final void setDontPersist(java.lang.String[] dontPersist)
dontPersist - a list of non-persistent attributespublic final oracle.adf.view.rich.event.ClientListenerSet getClientListeners()
public final void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)
clientListeners - a set of client listeners@Deprecated public final java.lang.String getContextMenuId()
contextMenu facet instead.NamingContainer, ":::" will search
from the grandparent NamingContainer, etc.@Deprecated public final void setContextMenuId(java.lang.String contextMenuId)
contextMenu facet instead.NamingContainer, ":::" will search
from the grandparent NamingContainer, etc.contextMenuId - the new context menu ID@Deprecated public final java.lang.String getBodyContextMenuId()
bodyContextMenu facet instead.NamingContainer, ":::" will search from the grandparent NamingContainer, etc.@Deprecated public final void setBodyContextMenuId(java.lang.String bodyContextMenuId)
bodyContextMenu facet instead.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.bodyContextMenuId - the new body context menu IDpublic final java.lang.String getSizing()
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:
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.
public final void setSizing(java.lang.String sizing)
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:
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.
sizing - either "fixed" or "auto"public java.lang.String getModelName()
PivotFilterBar with the same model name. If the model name is not specified then it can work with
any PivotFilterBar.public void setModelName(java.lang.String modelName)
PivotFilterBar with the same model name. If the model name is not specified then it can work with
any PivotFilterBar.public CellKey getActiveCellKey()
public void setActiveCellKey(CellKey activeCellKey)
public final java.lang.String getScrollPolicy()
public final void setScrollPolicy(java.lang.String scrollPolicy)
scrollPolicy - the new scrollPolicy valuepublic java.lang.String getValueSubmitPolicy()
VALUE_SUBMIT_POLICY_IMMEDIATE and VALUE_SUBMIT_POLICY_LAZY. When set to VALUE_SUBMIT_POLICY_IMMEDIATE,
the value(s) of the cell are submitted to the server when user navigates from cell to cell. When set to VALUE_SUBMIT_POLICY_LAZY mode,
value(s) are not submitted to the server until the user navigates outside of fetched cells which triggers a fetch operation, or the user performs an
action that causes a request to be sent to the server.
The default value is VALUE_SUBMIT_POLICY_IMMEDIATE.public void setValueSubmitPolicy(java.lang.String valueSubmitPolicy)
VALUE_SUBMIT_POLICY_IMMEDIATE and VALUE_SUBMIT_POLICY_LAZY. When set to VALUE_SUBMIT_POLICY_IMMEDIATE,
the value(s) of the cell are submitted to the server when user navigates from cell to cell. When set to VALUE_SUBMIT_POLICY_LAZY mode
value(s) are not submitted to the server until the user navigates outside of fetched cells which triggers a fetch operation, or the user performs an
action that causes a request to be sent to the server.
The default value is VALUE_SUBMIT_POLICY_IMMEDIATE.valueSubmitPolicy - the new valueSubmitPolicy value@Concealed public void setClientBlocks(java.util.List<DataBlock> clientBlocks)
@Concealed public java.util.List<DataBlock> getClientBlocks()
@Concealed public void cleanClientKeyManager()
@Concealed public void cleanStampState()
protected boolean visitChildren(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback)
visitChildren in class org.apache.myfaces.trinidad.component.UIXComponentprotected final boolean defaultVisitChildren(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)
public java.lang.String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBasepublic java.util.Collection<java.lang.String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolderpublic java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHoldergetClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBasepublic void addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolderaddClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBaseeventName - the name of the eventbehavior - the client behavior to add