oracle.dss.dataView
Class ViewFormatHandle

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

All Implemented Interfaces:

Formattable

public class ViewFormatHandle

extends BaseViewFormatHandle

implements Formattable

Wrapper class used to return a ViewFormat 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 ViewFormat will be used as a cell-level override of format properties for the cell. The contained ViewFormat will be merged with the default ViewFormat 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

ViewFormatHandle()
Constructor.

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

Method Summary

ViewFormat	getViewFormat() Retrieves the ViewFormat contained by this object.
void	setBaseViewFormat(BaseViewFormat baseViewFormat) Specifies the BaseViewFormat contained by this object.
void	setViewFormat(ViewFormat vf) Specifies the ViewFormat contained by this object.

Methods inherited from class oracle.dss.util.format.BaseViewFormatHandle

getBaseViewFormat, getRunRulesForViewFormat, getViewFormatID, setRunRulesForViewFormat, setViewFormatID

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewFormatHandle

public ViewFormatHandle()

Constructor.

ViewFormatHandle

public ViewFormatHandle(ViewFormat vf,
                        java.lang.String id,
                        int runRules)

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

Parameters:

vf - the ViewFormat this object will contain

id - the unique ID of the ViewFormat

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

Method Detail

getViewFormat

public ViewFormat getViewFormat()

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

Specified by:

getViewFormat in interface Formattable

Returns:

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

setViewFormat

public void setViewFormat(ViewFormat vf)

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

Specified by:

setViewFormat in interface Formattable

Parameters:

vf - The ViewFormat this object will contain, or null if this object should not contain a ViewFormat.

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.

Overrides:

setBaseViewFormat in class BaseViewFormatHandle

Parameters:

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