oracle.adf.view.faces.bi.component.pivotTable
Class UIPivotTable

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:

javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.NamingContainer, javax.faces.component.StateHolder

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

Since:

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

Nested Class Summary

static class	UIPivotTable.ActionType ActionType.CELL_IMAGE_CLICK is deprecated
static class	UIPivotTable.DataCellContent
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

Field Summary

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
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 java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_DELIVERY_KEY
static java.lang.String	CONTEXT_MENU_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTEXT_MENU_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DATA_CELL_CONTENT_KEY
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
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
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	INDENT_ENABLED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
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
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_FETCH_SIZE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHRINK_TO_FIT_KEY
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	START_COLUMN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	START_COLUMN_PIXEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	START_ROW_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	START_ROW_PIXEL_KEY
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

bindings

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIPivotTable()

Method Summary

void	addActionListener(javax.faces.event.ActionListener listener)
void	addCellImageClickListener(CellImageClickListener listener) Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead
void	addDrillListener(DrillListener listener)
void	addPivotListener(PivotListener listener)
void	addSortListener(SortListener listener)
void	broadcast(javax.faces.event.FacesEvent event) Delivers a wrapped event to the appropriate component.
void	cleanClientKeyManager()
void	cleanStampState() Check which blocks are on the client and clear the cells that are no longer on client
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() Gets the Map to use as the "varStatus".
protected void	drill(DrillEvent drillEvent)
protected void	fireEventToAppListener(javax.faces.context.FacesContext context, javax.faces.event.FacesEvent event)
javax.faces.el.MethodBinding	getAction()
javax.el.MethodExpression	getActionExpression()
javax.faces.el.MethodBinding	getActionListener()
javax.faces.event.ActionListener[]	getActionListeners()
UIPivotTable.ActionType	getActionType()
int	getAutoIndent() Retrieves the number of pixels that row labels of different levels are indented.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getBodyContextMenuId() Gets a search expression to identify the popup component containing the context menu that will be shown within the pivot table body, for clicks outside the selectable regions of the pivot table, such as the row header, column header, or data regions.
javax.faces.component.UIComponent	getCellComponent()
CellFormat	getCellFormat()
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.List<DataBlock>	getClientBlocks()
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 browser.
java.lang.String	getContentDelivery() Retrieves whether the content of the pivot table is delivered immediately or lazily.
java.lang.String	getContextMenuId() Gets a search expression to identify the popup component containing the context menu that will be shown for clicks within selectable regions of the pivot table, such as the row header, column header, or data regions.
java.lang.Object	getCurrentCellContext()
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) Note: dataAttribute has been deprecated.
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)
javax.el.MethodExpression	getDataFormat() Retrieves the pivot table's data cell CellFormat MethodExpression.
DataFormatManager	getDataFormatManager() Retrieves the pivot table's DataFormatManager
java.lang.String[]	getDontPersist() Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
javax.el.MethodExpression	getDrillAction()
DrillListener[]	getDrillListeners()
javax.el.MethodExpression	getDrillRequestedListener()
javax.el.MethodExpression	getDrillRequestingListener()
java.lang.String	getEmptyText() Retrieves the text of an empty pivot table.
java.lang.String	getFamily()
protected UIHeaderCell	getHeaderCell()
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)
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.
HeaderFormatManager	getHeaderFormatManager() Retrieves the pivot table's HeaderFormatManager
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.Object	getLocalValue()
protected java.lang.String	getMeasureName(QDR qdr)
java.lang.String	getModelName() Retrieves the model name of the Pivot Table.
java.lang.String[]	getPartialTriggers()
java.lang.String[]	getPersist() Gets List of persistent attributes that are persisting to a registered "Persistent Change Manager".
javax.el.MethodExpression	getPivotListener()
PivotListener[]	getPivotListeners()
java.lang.Object	getRawValue()
int	getRowFetchSize() Retrieves the number of rows to fetch in each pivot table block that is downloaded to the browser.
Selection	getSelection() Retrieves the Selection instance that indicates which dataCells and headerCells are selected in the pivot table.
java.lang.String	getSizing() Retrieves how 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()
SortListener[]	getSortListeners()
java.lang.String	getSortMode() Retrieves the sort mode.
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)
protected java.util.List<javax.faces.component.UIComponent>	getStamps(UIHeaderCell headerCell)
int	getStartColumn() Retrieves the index of the first column that this pivot table displays.
int	getStartRow() Retrieves the index of the first row that this pivot table displays.
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 allowed in this view.
boolean	isImmediate() returns true if the actionType is PIVOT_ACTION_TYPE
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 an event.
void	removeActionListener(javax.faces.event.ActionListener listener)
void	removeCellImageClickListener(CellImageClickListener listener) Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead
void	removeDrillListener(DrillListener listener)
void	removePivotListener(PivotListener listener)
void	removeSortListener(SortListener listener)
protected void	resetStamps()
void	setAction(javax.faces.el.MethodBinding action)
void	setActionExpression(javax.el.MethodExpression action)
void	setActionListener(javax.faces.el.MethodBinding listener)
void	setActionType(UIPivotTable.ActionType actionType)
void	setAutoIndent(int i) Specifies how much to indent row labels for each level in a hierarchy.
void	setBodyContextMenuId(java.lang.String bodyContextMenuId) Sets a search expression to identify the popup component containing the context menu that will be shown within the pivot table body, for clicks outside the selectable regions of the pivot table, such as the row header, column header, or data regions.
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)
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 browser.
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) Sets a search expression to identify the popup component containing the context menu that will be shown for clicks within selectable regions of the pivot table, such as the row header, column header, or data regions.
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 When dataFormat is specified, it overrides the built-in or application-specified dataFormatManager.
void	setDataFormatManager(DataFormatManager dataFormatManager) Specifies the pivot table's DataFormatManager
void	setDontPersist(java.lang.String[] dontPersist) Sets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
void	setDrillAction(javax.el.MethodExpression drillAction)
void	setDrillingEnabled(boolean b) Specifies whether drilling is allowed in this view.
void	setDrillRequestedListener(javax.el.MethodExpression drillRequestedListener)
void	setDrillRequestingListener(javax.el.MethodExpression drillRequestingListener)
void	setEmptyText(java.lang.String emptyText) Sets the text of an empty pivot table.
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.
void	setHeaderFormatManager(HeaderFormatManager headerFormatManager) Specifies the pivot table's HeaderFormatManager
void	setImmediate(boolean immediate) no-op.
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	setModelName(java.lang.String modelName) Specifies the model name of the Pivot Table.
void	setPartialTriggers(java.lang.String[] ids)
void	setPersist(java.lang.String[] persist) Sets List of persistent attributes that are persisting 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)
void	setRowFetchSize(int rowFetchSize) Specifies the number of rows to fetch in each pivot table block that is downloaded to the browser.
void	setSelection(Selection selection) Sets the Selection instance that indicates which dataCells, headerCells, etc., are selected in the pivot table.
void	setSizing(java.lang.String sizing) Specifies how 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)
void	setSortMode(java.lang.String sortMode) Specifies the sort mode.
void	setStartColumn(int c) Specifies the first column of data for this pivot table to display.
void	setStartRow(int r) Specifies the first row of data to display in this pivot table.
protected void	setStartSliceAfterDrill(DrillEvent drillEvent, QDR oldMemberQdr)
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)

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, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren

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

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll

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

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

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

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

START_ROW_PIXEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey START_ROW_PIXEL_KEY

START_COLUMN_PIXEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey START_COLUMN_PIXEL_KEY

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

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

public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

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

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTEXT_MENU_ID_KEY

BODY_CONTEXT_MENU_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey BODY_CONTEXT_MENU_ID_KEY

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

SHRINK_TO_FIT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHRINK_TO_FIT_KEY

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. 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. 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. Application developers should not use this

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

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

See Also:

Constant Field Values

Constructor Detail

UIPivotTable

public UIPivotTable()

Method Detail

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase

setPartialTriggers

public void setPartialTriggers(java.lang.String[] ids)

getPartialTriggers

public java.lang.String[] getPartialTriggers()

getDrillRequestingListener

public final javax.el.MethodExpression getDrillRequestingListener()

setDrillRequestingListener

public final void setDrillRequestingListener(javax.el.MethodExpression drillRequestingListener)

getDrillRequestedListener

public final javax.el.MethodExpression getDrillRequestedListener()

setDrillRequestedListener

public final void setDrillRequestedListener(javax.el.MethodExpression drillRequestedListener)

getDrillAction

public final javax.el.MethodExpression getDrillAction()

setDrillAction

public final void setDrillAction(javax.el.MethodExpression drillAction)

queueEvent

public void queueEvent(javax.faces.event.FacesEvent e)

Description copied from class: UIGrid

Queues an event. If there is a currency set on this grid, then the event will be wrapped so that when it is finally delivered, the correct currency will be restored.

Overrides:

queueEvent in class UIGrid

Parameters:

e - a FacesEvent

addDrillListener

public void addDrillListener(DrillListener listener)

removeDrillListener

public void removeDrillListener(DrillListener listener)

getDrillListeners

public DrillListener[] getDrillListeners()

sort

protected void sort(SortEvent.SortType type,
                    java.util.Map<java.lang.String,java.lang.Object> properties)

addSortListener

public void addSortListener(SortListener listener)

removeSortListener

public void removeSortListener(SortListener listener)

getSortListeners

public SortListener[] getSortListeners()

setSortListener

public final void setSortListener(javax.el.MethodExpression sortListener)

getSortListener

public final javax.el.MethodExpression getSortListener()

addPivotListener

public void addPivotListener(PivotListener listener)

removePivotListener

public void removePivotListener(PivotListener listener)

getPivotListeners

public PivotListener[] getPivotListeners()

setPivotListener

public final void setPivotListener(javax.el.MethodExpression pivotListener)

getPivotListener

public final javax.el.MethodExpression getPivotListener()

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()

Specified by:

getAction in interface javax.faces.component.ActionSource

setAction

public void setAction(javax.faces.el.MethodBinding action)

Specified by:

setAction in interface javax.faces.component.ActionSource

getActionExpression

public javax.el.MethodExpression getActionExpression()

Specified by:

getActionExpression in interface javax.faces.component.ActionSource2

setActionExpression

public void setActionExpression(javax.el.MethodExpression action)

Specified by:

setActionExpression in interface javax.faces.component.ActionSource2

getActionListener

public javax.faces.el.MethodBinding getActionListener()

Specified by:

getActionListener in interface javax.faces.component.ActionSource

setActionListener

public void setActionListener(javax.faces.el.MethodBinding listener)

Specified by:

setActionListener in interface javax.faces.component.ActionSource

addActionListener

public void addActionListener(javax.faces.event.ActionListener listener)

Specified by:

addActionListener in interface javax.faces.component.ActionSource

removeActionListener

public void removeActionListener(javax.faces.event.ActionListener listener)

Specified by:

removeActionListener in interface javax.faces.component.ActionSource

getActionListeners

public javax.faces.event.ActionListener[] getActionListeners()

Specified by:

getActionListeners in interface javax.faces.component.ActionSource

isImmediate

public boolean isImmediate()

returns true if the actionType is PIVOT_ACTION_TYPE

Specified by:

isImmediate in interface javax.faces.component.ActionSource

setImmediate

public void setImmediate(boolean immediate)

no-op. For UIXSingleStep components, even though it implements ActionSource, we do no have an immediate attribute. By default, if actionType is PIVOT_ACTION_TYPE, we set the phase to PhaseId.APPLY_REQUEST_VALUES, else we set the phase to PhaseId.INVOKE_APPLICATION.

Specified by:

setImmediate in interface javax.faces.component.ActionSource

getActionType

public UIPivotTable.ActionType getActionType()

setActionType

public void setActionType(UIPivotTable.ActionType actionType)

drill

protected void drill(DrillEvent drillEvent)

setStartSliceAfterDrill

protected void setStartSliceAfterDrill(DrillEvent drillEvent,
                                       QDR oldMemberQdr)

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)

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 allowed in this view. Drilling is enabled by default.

Parameters:

b - true to enable drilling; false to disable drilling.

isDrillingEnabled

public boolean isDrillingEnabled()

Retrieves whether drilling is allowed in this view. Drilling is enabled by default.

Returns:

true if drilling is enabled; false if drilling is disabled.

getLocalValue

public java.lang.Object getLocalValue()

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()

Description copied from class: UIGrid

Gets the Map to use as the "varStatus". This implementation supports the following keys:

• model - returns the DataModel
• cellKey - returns the current cellKey
• cellIndex - returns the current cellIndex
• current - returns the current cellData

Overrides:

createVarStatusMap in class UIGrid

getCellFormat

public CellFormat getCellFormat()

getRawValue

public java.lang.Object getRawValue()

getCellComponent

public javax.faces.component.UIComponent getCellComponent()

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:

each element must be of type UIComponent.

getHeaderCell

protected UIHeaderCell getHeaderCell()

getDataCell

protected UIDataCell getDataCell(java.lang.String dataAttribute)

Note: dataAttribute has been deprecated. Users should use a switcher instead.

getStamps

protected java.util.List<javax.faces.component.UIComponent> getStamps(UIHeaderCell headerCell)

getStamps

protected java.util.List<javax.faces.component.UIComponent> getStamps(UIDataCell dataCell)

resetStamps

protected void resetStamps()

getCurrentCellContext

public java.lang.Object getCurrentCellContext()

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)

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)

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)

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

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 new 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 this component
• "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 dataCells and headerCells are selected in the pivot table.

Returns:

a Selection instance

setSelection

public final void setSelection(Selection selection)

Sets the Selection instance that indicates which dataCells, headerCells, etc., 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.

Parameters:

rendered - true to render the status bar, false otherwise

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

setStartRow

public void setStartRow(int r)

Specifies the first row of data to display in this pivot table.

Parameters:

r - The index of the first row to display. Row indexes begin at zero.

getStartRow

public int getStartRow()

Retrieves the index of the first row that this pivot table displays. Row indexes begin at zero.

Returns:

The index of the first row that this pivot table displays.

setStartColumn

public void setStartColumn(int c)

Specifies the first column of data for this pivot table to display. Column indexes begin at zero.

Parameters:

c - The index of the first column to display.

getStartColumn

public int getStartColumn()

Retrieves the index of the first column that this pivot table displays. Column indexes begin at zero.

Returns:

The index of the first column that this pivot table displays.

setRowFetchSize

public void setRowFetchSize(int rowFetchSize)

Specifies the number of rows to fetch in each pivot table block that is downloaded to the browser. The default value is -1, which means that the pivot table will render using its internal default, which is 50 rows.

Parameters:

rowFetchSize - the number of rows to fetch in each pivot table block that is downloaded to the browser.

getRowFetchSize

public int getRowFetchSize()

Retrieves the number of rows to fetch in each pivot table block that is downloaded to the browser. The default value is -1, which means that the pivot table will render using its internal default, which is 50 rows.

Returns:

the number of rows to fetch in each pivot table block that is downloaded to the browser.

setColumnFetchSize

public void setColumnFetchSize(int columnFetchSize)

Specifies the number of columns to fetch in each pivot table block that is downloaded to the browser. The default value is -1, which means that the pivot table will render using its internal default, which is 15 columns.

Parameters:

columnFetchSize - the number of columns to fetch in each pivot table block that is downloaded to the browser.

getColumnFetchSize

public int getColumnFetchSize()

Retrieves the number of columns to fetch in each pivot table block that is downloaded to the browser. The default value is -1, which means that the pivot table will render using its internal default, which is 15 columns.

Returns:

the number of columns to fetch in each pivot table block that is downloaded to the browser.

isPivotLabelVisible

public boolean isPivotLabelVisible()

Indicates whether layer/dimension names appear on pivot handles

Returns:

true if layer/dimension names are visible, 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, false to prevent their display.

isPivotEnabled

public boolean isPivotEnabled()

Indicates whether pivoting is enabled.

Returns:

true if pivoting is enabled, false if pivoting is disabled.

setPivotEnabled

public void setPivotEnabled(boolean enabled)

Specifies whether pivoting is enabled.

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_GROUPED, UIPivotTable.SORT_UNGROUPED, or UIPivotTable.SORT_NONE. The default value is UIPivotTable.SORT_GROUPED.

Returns:

the sort mode

setSortMode

public void setSortMode(java.lang.String sortMode)

Specifies the sort mode. Either UIPivotTable.SORT_GROUPED, UIPivotTable.SORT_UNGROUPED, or UIPivotTable.SORT_NONE. The default value is UIPivotTable.SORT_GROUPED.

Parameters:

sortMode - the 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:

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:

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 trable'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 of an empty pivot table. If the text is enclosed in an html tag, it will be formatted. The formatting behavior is similar to outputFormatted component.

Returns:

the text to show in an empty pivot table

setEmptyText

public void setEmptyText(java.lang.String emptyText)

Sets the text of an empty pivot table. If the text is enclosed in an html tag, it will be formatted. The formatting behavior is similar to 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 "lazy" or "immediate". If "lazy", then pivot table's content is fetched after the pivot table is sent to the browser. If "immediate", then the pivot table content is immediately sent to the browser.

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 "lazy" or "immediate". If "lazy", then pivot table's content is fetched after the pivot table is sent to the browser. If "immediate", then the pivot table content is immediately sent to the browser. The default value is "lazy".

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 new customizationId value

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 customizationId value

getPersist

public final java.lang.String[] getPersist()

Gets List of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.

Returns:

the new persist value

setPersist

public final void setPersist(java.lang.String[] persist)

Sets List of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.

Parameters:

persist - the new persist value

getDontPersist

public final java.lang.String[] getDontPersist()

Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.

Returns:

the new dontPersist value

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)

Sets 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 - the new dontPersist value

getClientListeners

public final oracle.adf.view.rich.event.ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getContextMenuId

public final java.lang.String getContextMenuId()

Gets a search expression to identify the popup component containing the context menu that will be shown for clicks within selectable regions of the pivot table, such as the row header, column header, or data regions. 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

public final void setContextMenuId(java.lang.String contextMenuId)

Sets a search expression to identify the popup component containing the context menu that will be shown for clicks within selectable regions of the pivot table, such as the row header, column header, or data regions. 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

public final java.lang.String getBodyContextMenuId()

Gets a search expression to identify the popup component containing the context menu that will be shown within the pivot table body, for clicks outside the selectable regions of the pivot table, such as the row header, column header, or data regions. 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

public final void setBodyContextMenuId(java.lang.String bodyContextMenuId)

Sets a search expression to identify the popup component containing the context menu that will be shown within the pivot table body, for clicks outside the selectable regions of the pivot table, such as the row header, column header, or data regions. 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 body new context menu id

getSizing

public final java.lang.String getSizing()

Retrieves how pivot table's size ( width/height ) is determined. Valid values are "fixed" or "auto". When sizing="fixed", the pivot table is sized based in the width / height CSS properties in its default style or inline style property. When sizing="auto", 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. To control maximum height / width of the pivot table, the max-height / max-width CSS properties can be specified using pixels in the inlineStyle property of the pivot table, as follows "max-width:400px;max-height:300px". Once the maximum height or width is exceeded, then 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. The default value is "fixed".

Returns:

either "fixed" or "auto".

setSizing

public final void setSizing(java.lang.String sizing)

Specifies how pivot table's size ( width/height ) is determined. Valid values are "fixed" or "auto". When sizing="fixed", the pivot table is sized based in the width / height CSS properties in its default style or inline style property. When sizing="auto", 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. To control maximum height / width of the pivot table, the max-height / max-width CSS properties can be specified using pixels in the inlineStyle property of the pivot table, as follows "max-width:400px;max-height:300px". Once the maximum height or width is exceeded, then 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.

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.

setClientBlocks

public void setClientBlocks(java.util.List<DataBlock> clientBlocks)

For internal use only. Application developers should not use this

getClientBlocks

public java.util.List<DataBlock> getClientBlocks()

For internal use only. Application developers should not use this

cleanClientKeyManager

public void cleanClientKeyManager()

For internal use only. Application developers should not use this

cleanStampState

public void cleanStampState()

Check which blocks are on the client and clear the cells that are no longer on client

For internal use only. Application developers should not use this