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

java.lang.Object
  oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      oracle.adf.view.faces.bi.component.pivotTable.SizingManager
          oracle.adf.view.faces.bi.component.pivotTable.SizingManagerImpl

All Implemented Interfaces:

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

public class SizingManagerImpl
extends SizingManager

The pivot table's default SizingManager implementation.

Since:

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

See Also:

Serialized Form

Field Summary

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

AUTOSIZE, COLUMN_HEADER_ROW_HEIGHT_RULES_KEY, COLUMN_WIDTH_RULES_KEY, DEFAULT_COLUMN_HEADER_ROW_HEIGHT_KEY, DEFAULT_COLUMN_WIDTH_KEY, DEFAULT_ROW_HEADER_COLUMN_WIDTH_KEY, DEFAULT_ROW_HEIGHT_KEY, ROW_HEADER_COLUMN_WIDTH_RULES_KEY, ROW_HEIGHT_RULES_KEY, TYPE

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

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

SizingManagerImpl()
Sole constructor.

Method Summary

int	computeColumnHeaderRowHeight(java.lang.String layer) Returns the height in pixels of a layer on the pivot table's column header.
int	computeColumnWidth(QDR sliceQDR) Returns the width in pixels of the specified pivot table column.
protected int	computeLayerSize(java.util.List sizingRules, int defaultSize, java.lang.String layer) Returns the size in pixels of the specified layer.
int	computeRowHeaderColumnWidth(java.lang.String layer) Returns the width in pixels of a layer on the pivot table's row header.
int	computeRowHeight(QDR sliceQDR) Returns the height in pixels of the specified pivot table row.
protected int	computeSliceSize(java.util.List sizingRules, int defaultSize, QDR sliceQDR) Returns the size in pixels of the specified slice.
protected SizingRule	findLayerRule(java.util.List sizingRules, java.lang.String layer) Returns the last rule in the specified list that applies to the specified layer, or null if the list contains no such rule.
protected SizingRule	findSliceRule(java.util.List sizingRules, QDR sliceQDR) Returns the last rule in the specified list that applies to the specified slice, or null if the list contains no such rule.
java.util.List<SizingRule>	getOverriddenRules(java.util.List<SizingRule> rules, SizingRule rule) Retrieves a List of SizingRules that are overridden by the specified rule.
void	initRules() This method is called by the Pivot Table, before asking the SizingManager to compute sizes.
protected void	initRules(java.util.List sizingRules) Initializes all of the rules in the provided list.
void	removeOverriddenRules(java.util.List<SizingRule> rules, SizingRule rule) Removes SizingRules, from a List of SizingRules, that are overridden by the specified rule.

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

getBeanType, getColumnHeaderRowHeightRules, getColumnWidthRules, getDefaultColumnHeaderRowHeight, getDefaultColumnWidth, getDefaultRowHeaderColumnWidth, getDefaultRowHeight, getRowHeaderColumnWidthRules, getRowHeightRules, removeRules, restoreState, setColumnHeaderRowHeightRules, setColumnWidthRules, setDefaultColumnHeaderRowHeight, setDefaultColumnWidth, setDefaultRowHeaderColumnWidth, setDefaultRowHeight, setRowHeaderColumnWidthRules, setRowHeightRules

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

applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, 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

Constructor Detail

SizingManagerImpl

public SizingManagerImpl()

Sole constructor.

Method Detail

computeColumnWidth

public int computeColumnWidth(QDR sliceQDR)

Description copied from class: SizingManager

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

Specified by:

computeColumnWidth in class SizingManager

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 int computeRowHeight(QDR sliceQDR)

Description copied from class: SizingManager

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.

Specified by:

computeRowHeight in class SizingManager

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 int computeRowHeaderColumnWidth(java.lang.String layer)

Description copied from class: SizingManager

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

Specified by:

computeRowHeaderColumnWidth in class SizingManager

Parameters:

layer - the layer on the row header

Returns:

the width of the layer on the row header in pixels

computeColumnHeaderRowHeight

public int computeColumnHeaderRowHeight(java.lang.String layer)

Description copied from class: SizingManager

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.

Specified by:

computeColumnHeaderRowHeight in class SizingManager

Parameters:

layer - the layer on the column header

Returns:

the height of the layer on the column header in pixels

initRules

public void initRules()

Description copied from class: SizingManager

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

Specified by:

initRules in class SizingManager

initRules

protected void initRules(java.util.List sizingRules)

Initializes all of the rules in the provided list.

Parameters:

sizingRules - the rules to initialize

findSliceRule

protected SizingRule findSliceRule(java.util.List sizingRules,
                                   QDR sliceQDR)

Returns the last rule in the specified list that applies to the specified slice, or null if the list contains no such rule.

Parameters:

sizingRules - the list of sizing rules

sliceQDR - the QDR of the slice

Returns:

the applicable rule or null

findLayerRule

protected SizingRule findLayerRule(java.util.List sizingRules,
                                   java.lang.String layer)

Returns the last rule in the specified list that applies to the specified layer, or null if the list contains no such rule.

Parameters:

sizingRules - the list of sizing rules

layer - the layer of interest

Returns:

the applicable rule or null

computeSliceSize

protected int computeSliceSize(java.util.List sizingRules,
                               int defaultSize,
                               QDR sliceQDR)

Returns the size in pixels of the specified slice. If the specified sizing rules indicate a size for the slice, that size is returned; otherwise the specified default size is returned.

Parameters:

sizingRules - the sizing rules that might indicate a size for the slice

defaultSize - the size to use if none of the sizing rules apply to the slice

sliceQDR - the QDR of the slice of interest

Returns:

the size in pixels of the specified slice

computeLayerSize

protected int computeLayerSize(java.util.List sizingRules,
                               int defaultSize,
                               java.lang.String layer)

Returns the size in pixels of the specified layer. If the specified sizing rules indicate a size for the layer, that size is returned; otherwise the specified default size is returned.

Parameters:

sizingRules - the sizing rules that might indicate a size for the layer

defaultSize - the size to use if none of the sizing rules apply to the layer

layer - the layer of interest

Returns:

the size in pixels of the specified layer

getOverriddenRules

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

Retrieves a List of SizingRules that are overridden by the specified rule. By default, SizingManagerImpl only removes: - SliceSizingRuleImpls that override other SliceSizingRuleImpls. - LayerSizingRuleImpls that override other LayerSizingRuleImpls. Therefore, if an application creates custom SliceSizingRules or LayerSizingRules, then it will also need to extend SizingManagerImpl and override this method, if it wants: - its custom rules to be overridden by SliceSizingRuleImpl/LayerSizingRuleImpl - SliceSizingRuleImpl/LayerSizingRuleImpl to be able to override its custom rules. If the rule passed into an application's implmentation of getOverriddenRules is a SliceSizingRuleImpl/ LayerSizingRuleImpl, then it should call SizingManagerImpl.getOverriddenRules first, to collect a list of default rules that are overridden by the rule, and then it should perform a custom check to see if the rule overrides any custom rules in the list of rules. If the rule passed into an application's implmentation of getOverriddenRules is a custom rule, then it should perform a custom check to see if any rules in the list are overridden by the custom rule.

Specified by:

getOverriddenRules in class SizingManager

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 void removeOverriddenRules(java.util.List<SizingRule> rules,
                                  SizingRule rule)

Description copied from class: SizingManager

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

Specified by:

removeOverriddenRules in class SizingManager

Parameters:

rules - a List of SizingRules

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