public class ViewFormatHandle extends BaseViewFormatHandle implements Formattable
ViewFormat
to a view from the
data source, through the DataAccess
interface.
When DataMap.DATA_VIEWFORMAT
is passed as the type
parameter of the DataAccess.getValue
method, the
DataAccess
returns a ViewFormatHandle
.
The view uses the ViewFormat
that this handle wraps,
to format numbers in a cell.
The settings in the wrapped ViewFormat
take precedence over
those in the default ViewFormat
for a view component.
The RunRulesForViewFormat
property of this ViewFormatHandle
determines whether the view runs rules that can modify the wrapped
ViewFormat
.
If the view does not run rules, then the wrapped ViewFormat
specifies all of the number formatting for the cell.
Modifier and Type | Field and Description |
---|---|
protected ViewFormat |
m_viewFormat |
m_baseViewFormat, m_runRulesForViewFormat, m_viewFormatID
DO_NOT_RUN_RULES, RUN_RULES
Constructor and Description |
---|
ViewFormatHandle()
Constructor that takes no arguments.
|
ViewFormatHandle(ViewFormat vf,
java.lang.String id,
int runRules)
Constructor that specifies a
ViewFormat ,
an ID , and whether rules apply to the cell. |
Modifier and Type | Method and Description |
---|---|
ViewFormat |
getViewFormat()
Retrieves the
ViewFormat that this object wraps. |
oracle.dss.util.xml.ObjectNode |
getXML(java.lang.String name,
boolean allProperties)
Retrieves XML that represents properties and their values in the form
of and
ObjectNode . |
void |
setBaseViewFormat(BaseViewFormat baseViewFormat)
Specifies the
BaseViewFormat that this object wraps. |
void |
setViewFormat(ViewFormat vf)
Specifies the
ViewFormat that this object wraps. |
void |
setXML(oracle.dss.util.xml.ObjectNode node)
Specifies XML that represents properties and values.
|
getBaseViewFormat, getRunRulesForViewFormat, getViewFormatID, setRunRulesForViewFormat, setViewFormatID
protected ViewFormat m_viewFormat
public ViewFormatHandle()
ViewFormat
for this ViewFormatHandle
to wrap, and you must
specify whether rules apply to the cell.
You can also set a unique ID for the ViewFormat
.public ViewFormatHandle(ViewFormat vf, java.lang.String id, int runRules)
ViewFormat
,
an ID
, and whether rules apply to the cell.vf
- The ViewFormat
for this object to wrap.id
- A unique ID for the ViewFormat
.runRules
- A constant that indicates whether rules set on the view
should be run for a cell that uses baseViewFormat
.
Valid constants are listed in the See Also section.BaseMergeableHandle.RUN_RULES
,
BaseMergeableHandle.DO_NOT_RUN_RULES
public ViewFormat getViewFormat()
ViewFormat
that this object wraps.
The ViewFormat
that this method returns is merged with
the default ViewFormat
for the view component.
The settings in the returned ViewFormat
take precedence
over the default ViewFormat
.getViewFormat
in interface Formattable
ViewFormat
that this object wraps, or
null
if no ViewFormat
has been
set.public void setViewFormat(ViewFormat vf)
ViewFormat
that this object wraps.
The settings in the ViewFormat
that you pass to this method
take precedence over the default ViewFormat
for a view
component.setViewFormat
in interface Formattable
vf
- The ViewFormat
for this
ViewFormatHandle
.public void setBaseViewFormat(BaseViewFormat baseViewFormat)
BaseViewFormat
that this object wraps.
The settings in the BaseViewFormat
that you pass to this method
take precedence over the default BaseViewFormat
for a view
component.setBaseViewFormat
in class BaseViewFormatHandle
baseViewFormat
- The BaseViewFormat
for this
BaseViewFormatHandle
.public oracle.dss.util.xml.ObjectNode getXML(java.lang.String name, boolean allProperties)
ObjectNode
.allProperties
- true
to store all property values in XML,
false
to store only values that are different
from default values.public void setXML(oracle.dss.util.xml.ObjectNode node)
node
- ObjectNode
that has the properties and their values.