|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.adf.view.faces.bi.component.pivotTable.CellFormat
public class CellFormat
Indicates formatting that should be applied to a Pivot Table cell, including CSS styles for the cell and its text, a Converter
for converting the data value, and a replacement data value for the cell.
Field Summary | |
---|---|
static java.lang.Object |
UNSPECIFIED_RAW_VALUE A sentinel "new raw value" indicating that the raw value is not being overridden. |
Constructor Summary | |
---|---|
CellFormat() Constructs a new CellFormat . |
|
CellFormat(javax.faces.convert.Converter convert, java.lang.String style, java.lang.String textStyle) Constructs a new CellFormat . |
|
CellFormat(javax.faces.convert.Converter convert, java.lang.String style, java.lang.String textStyle, java.lang.Object newRawValue) Constructs a new CellFormat . |
Method Summary | |
---|---|
javax.faces.convert.Converter |
getConverter() Returns a Converter to use to convert raw values that are displayed in pivot table cells. |
java.util.Map<java.lang.String,java.lang.Object> |
getCustomData() Returns a custom data map that can be used by an application to return custom data values to components that are rendered in data cells. |
java.lang.String |
getDataAttributeQualifier() Returns a data attribute qualifier that can be used to refine the DataCell that is associated with a data cell, so that DataCell contents can vary on a cell by cell basis. |
CellImage[] |
getImages() Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead. |
java.lang.Object |
getNewRawValue() Returns a new raw value to display in the cell. |
java.lang.String |
getStyle() Returns the inline CSS style that should be applied to a pivot table cell. |
java.lang.String |
getTextStyle() Returns the inline CSS style that should be applied to a pivot table cell's text. |
protected void |
init(javax.faces.convert.Converter convert, java.lang.String style, java.lang.String textStyle, java.lang.Object newRawValue, CellImage[] images, java.lang.String dataAttributeQualifier) |
boolean |
isNewRawValueAvailable() Indicates whether a new raw value is provided for the cell. |
void |
setConverter(javax.faces.convert.Converter convert) Sets a Converter to use to convert raw values that are displayed in pivot table cells. |
void |
setCustomData(java.util.Map<java.lang.String,java.lang.Object> customData) Specifies a custom data map that can be used by an application to return custom data values to components that are rendered in data cells. |
void |
setDataAttributeQualifier(java.lang.String dataAttributeQualifier) Specifies a data attribute qualifier that can be used to refine the DataCell that is associated with a data cell, so that DataCell contents can vary on a cell by cell basis. |
void |
setImages(CellImage[] images) Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead. |
void |
setNewRawValue(java.lang.Object newRawValue) Specifies a new raw value to display in the cell. |
void |
setStyle(java.lang.String style) Sets the inline CSS style that should be applied to a pivot table cell. |
void |
setTextStyle(java.lang.String cssStyle) Sets the inline CSS style that should be applied to a pivot table cell's text. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.Object UNSPECIFIED_RAW_VALUE
Constructor Detail |
---|
public CellFormat()
CellFormat
.public CellFormat(javax.faces.convert.Converter convert, java.lang.String style, java.lang.String textStyle)
CellFormat
.
convert
- a converter for converting raw data valuesstyle
- the inline CSS style that should be applied to a pivot table celltextStyle
- the inline CSS style that should be applied to a pivot table cell's textpublic CellFormat(javax.faces.convert.Converter convert, java.lang.String style, java.lang.String textStyle, java.lang.Object newRawValue)
CellFormat
.
convert
- a converter for converting raw data valuesstyle
- the inline CSS style that should be applied to a pivot table celltextStyle
- the inline CSS style that should be applied to a pivot table cell's textnewRawValue
- a new raw value to display in the cellMethod Detail |
---|
protected void init(javax.faces.convert.Converter convert, java.lang.String style, java.lang.String textStyle, java.lang.Object newRawValue, CellImage[] images, java.lang.String dataAttributeQualifier)
public javax.faces.convert.Converter getConverter()
Converter
to use to convert raw values that are displayed in pivot table cells.public void setConverter(javax.faces.convert.Converter convert)
Converter
to use to convert raw values that are displayed in pivot table cells.convert
- the converter to use to convert raw valuespublic java.lang.String getTextStyle()
public void setTextStyle(java.lang.String cssStyle)
cssStyle
- the text CSS stylepublic java.lang.String getStyle()
public void setStyle(java.lang.String style)
style
- the cell CSS style
@Deprecated
public void setImages(CellImage[] images)
<dvt:dataCell>
with child tag <af:image>
or <af:commandImageLink>
instead.images
- the images to render in a pivot table cell
@Deprecated
public CellImage[] getImages()
<dvt:dataCell>
with child tag <af:image>
or <af:commandImageLink>
instead.public boolean isNewRawValueAvailable()
true
if a new raw value is available; false
otherwisepublic java.lang.Object getNewRawValue()
public void setNewRawValue(java.lang.Object newRawValue)
CellFormat.UNSPECIFIED_RAW_VALUE
.newRawValue
- a new raw value to display in the cellpublic java.lang.String getDataAttributeQualifier()
public void setDataAttributeQualifier(java.lang.String dataAttributeQualifier)
dataAttributeQualifier
- the data attribute qualifierpublic void setCustomData(java.util.Map<java.lang.String,java.lang.Object> customData)
customData
- a map of custom data valuespublic java.util.Map<java.lang.String,java.lang.Object> getCustomData()
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |