oracle.dss.util.format
Class BaseViewFormatHandle

java.lang.Object
  |
  +--oracle.dss.util.format.BaseMergeableHandle
        |
        +--oracle.dss.util.format.BaseViewFormatHandle

Direct Known Subclasses:

ViewFormatHandle

public class BaseViewFormatHandle

extends BaseMergeableHandle

Wrapper class used to return a BaseViewFormat to a view from the data source through the DataAccess interface. This object may be returned through a call to the DataAccess methods getValue, when the requested data layer is DataMap.DATA_VIEWFORMAT. If this object is returned by the data source for a particular cell, the contained BaseViewFormat will be used as a cell-level override of format properties for the cell. The contained BaseViewFormat will be merged with the default BaseViewFormat for the component, and will take precedence over defaults.

Fields inherited from class oracle.dss.util.format.BaseMergeableHandle

DO_NOT_RUN_RULES, RUN_RULES

Constructor Summary

BaseViewFormatHandle()
Constructor.

BaseViewFormatHandle(BaseViewFormat baseViewFormat, java.lang.String id, int runRules)
Constructor that takes the BaseViewFormat this class will contain, the unique ID for that BaseViewFormat, and a constant indicating whether or not rules should be run when the contained BaseViewFormat is used for formatting a cell.

Method Summary

BaseViewFormat	getBaseViewFormat() Retrieves the BaseViewFormat contained by this object.
int	getRunRulesForViewFormat() Determine if rules are run when the contained BaseViewFormat is used to format a cell.
java.lang.String	getViewFormatID() Get the unique ID for the contained BaseViewFormat.
void	setBaseViewFormat(BaseViewFormat baseViewFormat) Specifies the BaseViewFormat contained by this object.
void	setRunRulesForViewFormat(int runRules) Specify whether or not rules are run when the contained BaseViewFormat is used to format a cell.
void	setViewFormatID(java.lang.String id) Set the unique ID for the contained BaseViewFormat.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseViewFormatHandle

public BaseViewFormatHandle()

Constructor.

BaseViewFormatHandle

public BaseViewFormatHandle(BaseViewFormat baseViewFormat,
                            java.lang.String id,
                            int runRules)

Constructor that takes the BaseViewFormat this class will contain, the unique ID for that BaseViewFormat, and a constant indicating whether or not rules should be run when the contained BaseViewFormat is used for formatting a cell.

Parameters:

baseViewFormat - the BaseViewFormat this object will contain

id - the unique ID of the BaseViewFormat

runRules - constant indicating whether or not rules should be run when using the contained BaseViewFormat; valid constants are defined in the superclass

Method Detail

getBaseViewFormat

public BaseViewFormat getBaseViewFormat()

Retrieves the BaseViewFormat contained by this object. This BaseViewFormat will be merged with the default BaseViewFormat for the component being painted, and will take precedence over defaults.

Returns:

The BaseViewFormat contained by this object, or null if no BaseViewFormat is contained by this object.

setBaseViewFormat

public void setBaseViewFormat(BaseViewFormat baseViewFormat)

Specifies the BaseViewFormat contained by this object. This BaseViewFormat will be merged with the default BaseViewFormat for the component being painted, and will take precedence over defaults.

Parameters:

baseViewFormat - The BaseViewFormat this object will contain, or null if this object should not contain a BaseViewFormat.

getViewFormatID

public java.lang.String getViewFormatID()

Get the unique ID for the contained BaseViewFormat.

Returns:

the unique ID for the contained BaseViewFormat, or null if a unique ID is not available

setViewFormatID

public void setViewFormatID(java.lang.String id)

Set the unique ID for the contained BaseViewFormat.

Parameters:

id - the unique ID for the contained BaseViewFormat, or null if a unique ID is not available

getRunRulesForViewFormat

public int getRunRulesForViewFormat()

Determine if rules are run when the contained BaseViewFormat is used to format a cell. Valid constants, RUN_RULES and DO_NOT_RUN_RULES, are defined in the superclass. If this property is set to RUN_RULES, then when the contained BaseViewFormat is used to format a cell, format rules will be run for the cell and the results will take precedence over the contained BaseViewFormat. If this property is set to DO_NOT_RUN_RULES, then when the contained BaseViewFormat is used to format a cell, no format rules will be run.

Returns:

constant indicating whether or not rules should be run when using the contained BaseViewFormat

setRunRulesForViewFormat

public void setRunRulesForViewFormat(int runRules)

Specify whether or not rules are run when the contained BaseViewFormat is used to format a cell. Valid constants, RUN_RULES and DO_NOT_RUN_RULES, are defined in the superclass. If this property is set to RUN_RULES, then when the contained BaseViewFormat is used to format a cell, format rules will be run for the cell and the results will take precedence over the contained BaseViewFormat. If this property is set to DO_NOT_RUN_RULES, then when the contained BaseViewFormat is used to format a cell, no format rules will be run.

Parameters:

runRules - constant indicating whether or not rules should be run when using the contained BaseViewFormat