public class BaseViewFormatHandle extends BaseMergeableHandle
BaseViewFormat
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 BaseViewFormatHandle
.
The view uses the BaseViewFormat
that this handle wraps,
to format numbers in a cell.
The settings in the wrapped BaseViewFormat
take precedence over
those in the default BaseViewFormat
for a view component.
The RunRulesForViewFormat
property of this BaseViewFormatHandle
determines whether the view runs rules on the wrapped
BaseViewFormat
.
If the view does not run rules, then the wrapped BaseViewFormat
specifies all of the number formatting for the cell.
Modifier and Type | Field and Description |
---|---|
protected BaseViewFormat |
m_baseViewFormat |
protected int |
m_runRulesForViewFormat |
protected java.lang.String |
m_viewFormatID |
DO_NOT_RUN_RULES, RUN_RULES
Constructor and Description |
---|
BaseViewFormatHandle()
Constructor that takes no arguments.
|
BaseViewFormatHandle(BaseViewFormat baseViewFormat,
java.lang.String id,
int runRules)
Constructor that specifies a
BaseViewFormat ,
an ID , and whether rules apply to the cell. |
Modifier and Type | Method and Description |
---|---|
BaseViewFormat |
getBaseViewFormat()
Retrieves the
BaseViewFormat that this object wraps. |
int |
getRunRulesForViewFormat()
Indicates whether the view should run rules on the cell for which
the
BaseViewFormat provides formatting. |
java.lang.String |
getViewFormatID()
Retrieves the ID of the
BaseViewFormat that this
BaseViewFormatHandle wraps. |
void |
setBaseViewFormat(BaseViewFormat baseViewFormat)
Specifies the
BaseViewFormat that this object wraps. |
void |
setRunRulesForViewFormat(int runRules)
Specifies whether the view should run rules on the cell for which
the
BaseViewFormat provides formatting. |
void |
setViewFormatID(java.lang.String id)
Specifies a unique ID for
BaseViewFormat that this
BaseViewFormatHandle wraps. |
protected BaseViewFormat m_baseViewFormat
protected java.lang.String m_viewFormatID
protected int m_runRulesForViewFormat
public BaseViewFormatHandle()
BaseViewFormat
for this BaseViewFormatHandle
to wrap, and you must
specify whether rules apply to the cell.
You can also set a unique ID for the BaseViewFormat
.public BaseViewFormatHandle(BaseViewFormat baseViewFormat, java.lang.String id, int runRules)
BaseViewFormat
,
an ID
, and whether rules apply to the cell.baseViewFormat
- The BaseViewFormat
for this object to wrap.id
- A unique ID for the BaseViewFormat
.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 BaseViewFormat getBaseViewFormat()
BaseViewFormat
that this object wraps.
The BaseViewFormat
that this method returns is merged with
the default BaseViewFormat
for the view component.
The settings in the returned BaseViewFormat
take precedence
over the default BaseViewFormat
.BaseViewFormat
that this object wraps, or
null
if no BaseViewFormat
has been
set.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.baseViewFormat
- The BaseViewFormat
for this
BaseViewFormatHandle
.public java.lang.String getViewFormatID()
BaseViewFormat
that this
BaseViewFormatHandle
wraps.BaseViewFormat
, or
null
if no ID has been specified.public void setViewFormatID(java.lang.String id)
BaseViewFormat
that this
BaseViewFormatHandle
wraps.id
- An ID for the BaseViewFormat
.public int getRunRulesForViewFormat()
BaseViewFormat
provides formatting.
If the view runs rules, then the format settings in the
BaseViewFormat
can be overridden by those specified in the
rules.
If the view does not run rules, then the format settings in the
BaseViewFormat
determine the number formatting for the cell.BaseViewFormat
that this
BaseViewFormatHandle
wraps. Valid constants are
listed in the See Also section.BaseMergeableHandle.RUN_RULES
,
BaseMergeableHandle.DO_NOT_RUN_RULES
public void setRunRulesForViewFormat(int runRules)
BaseViewFormat
provides formatting.
If the view runs rules, then the format settings in the
BaseViewFormat
can be overridden by those specified in the
rules.
If the view does not run rules, then the format settings in the
BaseViewFormat
determine the number formatting for the cell.runRules
- A constant that indicates whether the view should run rules
that can override settings in the BaseViewFormat
that
this BaseViewFormatHandle
wraps. Valid constants are
listed in the See Also section.BaseMergeableHandle.RUN_RULES
,
BaseMergeableHandle.DO_NOT_RUN_RULES