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

Class SizingManager

java.lang.Object

oracle.adf.view.faces.bi.component.BIComplexAttributeBase

oracle.adf.view.faces.bi.component.pivotTable.SizingManager

All Implemented Interfaces:

java.io.Serializable, javax.faces.component.StateHolder

Direct Known Subclasses:

SizingManagerImpl

public abstract class SizingManager
extends BIComplexAttributeBase
implements java.io.Serializable

The SizingManager is used to specify pivot table column widths, row heights, row header column widths, and column header row heights.

Since:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTOSIZE Value used to specify that a column width / row height should be ignored and that row/column autosizing should occur for the specified row/column.
static org.apache.myfaces.trinidad.bean.PropertyKey	COLUMN_HEADER_ROW_HEIGHT_RULES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLUMN_WIDTH_RULES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DEFAULT_COLUMN_HEADER_ROW_HEIGHT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DEFAULT_COLUMN_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DEFAULT_ROW_HEADER_COLUMN_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DEFAULT_ROW_HEIGHT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_HEADER_COLUMN_WIDTH_RULES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_HEIGHT_RULES_KEY
static int	SCROLL_SIZE Value used to specify that a row height should be determined by the maximum scroll height of all elements within the cells of the specified row.
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors

Constructor and Description
SizingManager() Sole constructor.

Method Summary

Modifier and Type	Method and Description
abstract int	computeColumnHeaderRowHeight(java.lang.String layer) Returns the height in pixels of a layer on the pivot table's column header.
abstract int	computeColumnWidth(QDR sliceQDR) Returns the width in pixels of the specified pivot table column.
abstract int	computeRowHeaderColumnWidth(java.lang.String layer) Returns the width in pixels of a layer on the pivot table's row header.
abstract int	computeRowHeight(QDR sliceQDR) Returns the height in pixels of the specified pivot table row.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.util.List<SizingRule>	getColumnHeaderRowHeightRules() Retrieves a List of SizingRules that are used to specify column header row heights.
java.util.List<SizingRule>	getColumnWidthRules() Retrieves a List of SizingRules that are used to specify column widths.
int	getDefaultColumnHeaderRowHeight() Retrieves the default column header row height.
int	getDefaultColumnWidth() Retrieves the default column width.
int	getDefaultRowHeaderColumnWidth() Retrieves the default row header column width.
int	getDefaultRowHeight() Retrieves the default row height.
abstract java.util.List<SizingRule>	getOverriddenRules(java.util.List<SizingRule> rules, SizingRule rule) Retrieves a List of SizingRules that are overridden by the specified rule.
java.util.List<SizingRule>	getRowHeaderColumnWidthRules() Retrieves a List of SizingRules that are used to specify row header column widths.
java.util.List<SizingRule>	getRowHeightRules() Retrieves a List of SizingRules that are used to specify row heights.
abstract void	initRules() This method is called by the Pivot Table, before asking the SizingManager to compute sizes.
abstract void	removeOverriddenRules(java.util.List<SizingRule> rules, SizingRule rule) Removes SizingRules, from a List of SizingRules, that are overridden by the specified rule.
void	removeRules(java.util.List<SizingRule> rules) The Pivot Table calls this method whenever a layout change / pivot is performed by the end user.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object stateObj)
void	setColumnHeaderRowHeightRules(java.util.List<SizingRule> rules) Specifies a List of SizingRules that are used to specify column header row heights.
void	setColumnWidthRules(java.util.List<SizingRule> rules) Specifies a List of SizingRules that are used to specify column widths.
void	setDefaultColumnHeaderRowHeight(int height) Specifies the default column header row height.
void	setDefaultColumnWidth(int width) Specifies the default column width.
void	setDefaultRowHeaderColumnWidth(int width) Specifies the default row header column width.
void	setDefaultRowHeight(int height) Specifies the default row height.
void	setRowHeaderColumnWidthRules(java.util.List<SizingRule> rules) Specifies a List of SizingRules that are used to specify row header column widths.
void	setRowHeightRules(java.util.List<SizingRule> rules) Specifies a List of SizingRules that are used to specify row heights.

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, registerAttachedObjectKey, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

DEFAULT_COLUMN_WIDTH_KEY

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

DEFAULT_ROW_HEIGHT_KEY

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

DEFAULT_COLUMN_HEADER_ROW_HEIGHT_KEY

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

DEFAULT_ROW_HEADER_COLUMN_WIDTH_KEY

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

ROW_HEIGHT_RULES_KEY

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

COLUMN_WIDTH_RULES_KEY

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

COLUMN_HEADER_ROW_HEIGHT_RULES_KEY

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

ROW_HEADER_COLUMN_WIDTH_RULES_KEY

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

AUTOSIZE

public static final int AUTOSIZE

Value used to specify that a column width / row height should be ignored and that row/column autosizing should occur for the specified row/column.

See Also:

Constant Field Values

SCROLL_SIZE

public static final int SCROLL_SIZE

Value used to specify that a row height should be determined by the maximum scroll height of all elements within the cells of the specified row. Note that the scroll height does not account for any padding/border/margin specified on the element. To get the accurate result, it is recommended to not set any padding/border/margin when SCROLL_SIZE is used. This value should only be used for row height and will cause Pivot Table to throw a IllegalStateException if it is returned in computeColumnWidth, computeRowHeaderColumnWidth, computeColumnHeaderRowHeight

See Also:

Constant Field Values

Constructor Detail

SizingManager

public SizingManager()

Sole constructor.

Method Detail

computeColumnWidth

public abstract int computeColumnWidth(QDR sliceQDR)

Returns the width in pixels of the specified pivot table column.

Parameters:

sliceQDR - the QDR of the desired column, containing a key/value pair for each header cell in the column

Returns:

the column width in pixels

computeRowHeight

public abstract int computeRowHeight(QDR sliceQDR)

Returns the height in pixels of the specified pivot table row. Please note that the return value of this property cannot be used to shrink the height of a row's contents. In other words, if the returned row height is too small for the row's contents, then the row height will be set to be large enough to view all of the row's contents.

Parameters:

sliceQDR - the QDR of the desired row, containing a key/value pair for each header cell in the row

Returns:

the row height in pixels

computeRowHeaderColumnWidth

public abstract int computeRowHeaderColumnWidth(java.lang.String layer)

Returns the width in pixels of a layer on the pivot table's row header.

Parameters:

layer - the layer on the row header

Returns:

the width of the layer on the row header in pixels

computeColumnHeaderRowHeight

public abstract int computeColumnHeaderRowHeight(java.lang.String layer)

Returns the height in pixels of a layer on the pivot table's column header. Please note that the return value of this property cannot be used to shrink the height of a row's contents. In other words, if the returned row height is too small for the row's contents, then the row height will be set to be large enough to view all of the row's contents.

Parameters:

layer - the layer on the column header

Returns:

the height of the layer on the column header in pixels

removeRules

public void removeRules(java.util.List<SizingRule> rules)

The Pivot Table calls this method whenever a layout change / pivot is performed by the end user. By default, this method only removes rules that are SliceSizingRulesImpls that have their removedAfterLayoutChange property set to true, which is the default for SliceSizingRulesImpls. Since the Pivot Table is not notified of query changes made by an application, applications should call this method: - using the column width sizing rule list, if the application explicitly changes the layout of column edge - using the row height sizing rule list, if the application explicitly changes the layout of row edge

Parameters:

rules - a List of SizingRules

initRules

public abstract void initRules()

This method is called by the Pivot Table, before asking the SizingManager to compute sizes.

getDefaultColumnWidth

public int getDefaultColumnWidth()

Retrieves the default column width.

Returns:

the default column width in pixels

setDefaultColumnWidth

public void setDefaultColumnWidth(int width)

Specifies the default column width. An invalid value will cause a IllegalStateException when Pivot Table calls computeColumnWidth.

Parameters:

width - the default column width in pixels

getDefaultRowHeight

public int getDefaultRowHeight()

Retrieves the default row height.

Returns:

the default row height in pixels

setDefaultRowHeight

public void setDefaultRowHeight(int height)

Specifies the default row height. An invalid value will cause a IllegalStateException when Pivot Table calls computeRowHeight.

Parameters:

height - the default row height in pixels

getDefaultRowHeaderColumnWidth

public int getDefaultRowHeaderColumnWidth()

Retrieves the default row header column width.

Returns:

the default row header column width in pixels

setDefaultRowHeaderColumnWidth

public void setDefaultRowHeaderColumnWidth(int width)

Specifies the default row header column width. An invalid value will cause a IllegalStateException when Pivot Table calls computeRowHeaderColumnWidth.

Parameters:

width - the default column width in pixels

getDefaultColumnHeaderRowHeight

public int getDefaultColumnHeaderRowHeight()

Retrieves the default column header row height.

Returns:

the default row height in pixels

setDefaultColumnHeaderRowHeight

public void setDefaultColumnHeaderRowHeight(int height)

Specifies the default column header row height. An invalid value will cause a IllegalStateException when Pivot Table calls computeColumnHeaderRowHeight.

Parameters:

height - the default column header row height in pixels

getColumnWidthRules

public java.util.List<SizingRule> getColumnWidthRules()

Retrieves a List of SizingRules that are used to specify column widths. This list should only contain SliceSizingRules or custom SizingRules.

Returns:

a List of SizingRules

setColumnWidthRules

public void setColumnWidthRules(java.util.List<SizingRule> rules)

Specifies a List of SizingRules that are used to specify column widths. This list should only contain SliceSizingRules or custom SizingRules.

Parameters:

rules - a List of SizingRules

getRowHeightRules

public java.util.List<SizingRule> getRowHeightRules()

Retrieves a List of SizingRules that are used to specify row heights. This list should only contain SliceSizingRules or custom SizingRules.

Returns:

a List of SizingRules

setRowHeightRules

public void setRowHeightRules(java.util.List<SizingRule> rules)

Specifies a List of SizingRules that are used to specify row heights. This list should only contain SliceSizingRules or custom SizingRules.

Parameters:

rules - a List of SizingRules

getRowHeaderColumnWidthRules

public java.util.List<SizingRule> getRowHeaderColumnWidthRules()

Retrieves a List of SizingRules that are used to specify row header column widths. This list should only contain LayerSizingRules or custom SizingRules.

Returns:

a List of SizingRules

setRowHeaderColumnWidthRules

public void setRowHeaderColumnWidthRules(java.util.List<SizingRule> rules)

Specifies a List of SizingRules that are used to specify row header column widths. This list should only contain LayerSizingRules or custom SizingRules.

Parameters:

rules - a List of SizingRules

getColumnHeaderRowHeightRules

public java.util.List<SizingRule> getColumnHeaderRowHeightRules()

Retrieves a List of SizingRules that are used to specify column header row heights. This list should only contain LayerSizingRuless or custom SizingRules.

Returns:

a List of SizingRules

setColumnHeaderRowHeightRules

public void setColumnHeaderRowHeightRules(java.util.List<SizingRule> rules)

Specifies a List of SizingRules that are used to specify column header row heights. This list should only contain LayerSizingRuless or custom SizingRules.

Parameters:

rules - a List of SizingRules

getOverriddenRules

public abstract java.util.List<SizingRule> getOverriddenRules(java.util.List<SizingRule> rules,
                                                              SizingRule rule)

Retrieves a List of SizingRules that are overridden by the specified rule.

Parameters:

rules - a List of SizingRules

rule - a SizingRule instance that is used to determine the overridden rules

Returns:

a List of overridden SizingRules

removeOverriddenRules

public abstract void removeOverriddenRules(java.util.List<SizingRule> rules,
                                           SizingRule rule)

Removes SizingRules, from a List of SizingRules, that are overridden by the specified rule.

Parameters:

rules - a List of SizingRules

rule - a SizingRule instance that is used to determine the overridden rules

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object stateObj)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class BIComplexAttributeBase

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase