oracle.dss.dataView
Class ViewStyleHandle

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

All Implemented Interfaces:

Styleable

public class ViewStyleHandle

extends BaseMergeableHandle

implements Styleable

Wrapper class used to return a ViewStyle to a view from the data source through the DataAccess interface. This object may be returned through a call to the DataAccess methods getValue and getMemberMetadata, when the requested data layer is DataMap.DATA_VIEWSTYLE or MetadataMap.METADATA_VIEWSTYLE, respectively. If this object is returned by the data source for a particular cell, the contained ViewStyle will be used as a cell-level override of style properties for the cell. The contained ViewStyle will be merged with the default ViewStyle 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

ViewStyleHandle()
Constructor.

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

Method Summary

int	getRunRulesForViewStyle() Determine if rules are run when the contained ViewStyle is used to paint a cell.
ViewStyle	getViewStyle() Retrieves the ViewStyle contained by this object.
java.lang.String	getViewStyleID() Get the unique ID for the contained ViewStyle.
void	setRunRulesForViewStyle(int runRules) Specify whether or not rules are run when the contained ViewStyle is used to paint a cell.
void	setViewStyle(ViewStyle vs) Specifies the ViewStyle contained by this object.
void	setViewStyleID(java.lang.String id) Set the unique ID for the contained ViewStyle.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewStyleHandle

public ViewStyleHandle()

Constructor.

ViewStyleHandle

public ViewStyleHandle(ViewStyle vs,
                       java.lang.String id,
                       int runRules)

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

Parameters:

vs - the ViewStyle this object will contain

id - the unique ID of the ViewStyle

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

Method Detail

getViewStyle

public ViewStyle getViewStyle()

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

Specified by:

getViewStyle in interface Styleable

Returns:

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

setViewStyle

public void setViewStyle(ViewStyle vs)

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

Specified by:

setViewStyle in interface Styleable

Parameters:

vs - The ViewStyle this object will contain, or null if this object should not contain a ViewStyle.

getViewStyleID

public java.lang.String getViewStyleID()

Get the unique ID for the contained ViewStyle.

Returns:

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

setViewStyleID

public void setViewStyleID(java.lang.String id)

Set the unique ID for the contained ViewStyle.

Parameters:

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

getRunRulesForViewStyle

public int getRunRulesForViewStyle()

Determine if rules are run when the contained ViewStyle is used to paint 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 ViewStyle is used to paint a cell, style rules will be run for the cell and the results will take precedence over the contained ViewStyle. If this property is set to DO_NOT_RUN_RULES, then when the contained ViewStyle is used to paint a cell, no style rules will be run.

Returns:

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

setRunRulesForViewStyle

public void setRunRulesForViewStyle(int runRules)

Specify whether or not rules are run when the contained ViewStyle is used to paint 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 ViewStyle is used to paint a cell, style rules will be run for the cell and the results will take precedence over the contained ViewStyle. If this property is set to DO_NOT_RUN_RULES, then when the contained ViewStyle is used to paint a cell, no style rules will be run.

Parameters:

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