oracle.adf.view.faces.bi.component.pivotTable
Class CellFormat

java.lang.Object
  oracle.adf.view.faces.bi.component.pivotTable.CellFormat

public class CellFormat
extends java.lang.Object

Field Summary

static java.lang.Object

UNSPECIFIED_RAW_VALUE A raw value that indicates that Specify a new raw value to display in the cell

Constructor Summary

CellFormat()

CellFormat(javax.faces.convert.Converter convert, java.lang.String style, java.lang.String textStyle)

CellFormat(javax.faces.convert.Converter convert, java.lang.String style, java.lang.String textStyle, java.lang.Object newRawValue)

Method Summary

javax.faces.convert.Converter	getConverter() Return 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 rendereed 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() Return a new raw value to display in the cell
java.lang.String	getStyle() Return the inline CSS style that should be rendered in a pivot table cell.
java.lang.String	getTextStyle() Return 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() Returns whether a new raw value is provided for the cell
void	setConverter(javax.faces.convert.Converter convert) Set 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 rendereed 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) Specify a new raw value to display in the cell.
void	setStyle(java.lang.String style) Set the inline CSS style that should be rendered in a pivot table cell.
void	setTextStyle(java.lang.String cssStyle) Set 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

UNSPECIFIED_RAW_VALUE

public static final java.lang.Object UNSPECIFIED_RAW_VALUE

A raw value that indicates that Specify a new raw value to display in the cell

Constructor Detail

CellFormat

public CellFormat()

CellFormat

public CellFormat(javax.faces.convert.Converter convert,
                  java.lang.String style,
                  java.lang.String textStyle)

CellFormat

public CellFormat(javax.faces.convert.Converter convert,
                  java.lang.String style,
                  java.lang.String textStyle,
                  java.lang.Object newRawValue)

Method Detail

init

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)

getConverter

public javax.faces.convert.Converter getConverter()

Return a Converter to use to convert raw values that are displayed in pivot table cells

Returns:

the converter to use to convert raw values

setConverter

public void setConverter(javax.faces.convert.Converter convert)

Set a Converter to use to convert raw values that are displayed in pivot table cells

Parameters:

convert - the converter to use to convert raw values

getTextStyle

public java.lang.String getTextStyle()

Return the inline CSS style that should be applied to a pivot table cell's text

Returns:

the text CSS style

setTextStyle

public void setTextStyle(java.lang.String cssStyle)

Set the inline CSS style that should be applied to a pivot table cell's text

Parameters:

cssStyle - the inline CSS style to apply to a pivot table cell's text

getStyle

public java.lang.String getStyle()

Return the inline CSS style that should be rendered in a pivot table cell.

Returns:

String

setStyle

public void setStyle(java.lang.String style)

Set the inline CSS style that should be rendered in a pivot table cell.

Parameters:

style - the inline CSS style to apply to a pivot table cell

setImages

@Deprecated
public void setImages(CellImage[] images)

Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead

Set the images that should be rendered in a pivot table cell, in the order they should be rendered.

Parameters:

images - the images to render in a pivot table cell

getImages

@Deprecated
public CellImage[] getImages()

Deprecated. Use <dvt:dataCell> with child tag <af:image> or <af:commandImageLink> instead

Return the images that should be rendered in a pivot table cell, in the order they should be rendered.

Returns:

the images to render in a pivot table cell

isNewRawValueAvailable

public boolean isNewRawValueAvailable()

Returns whether a new raw value is provided for the cell

Returns:

whether a new raw value is available

getNewRawValue

public java.lang.Object getNewRawValue()

Return a new raw value to display in the cell

Returns:

a new raw value

setNewRawValue

public void setNewRawValue(java.lang.Object newRawValue)

Specify a new raw value to display in the cell. To indicate that the new raw value shouldn't be displayed in the cell, the raw value should be set to CellFormat.UNSPECIFIED_RAW_VALUE. This value is typically only used when supplying new raw values to

Parameters:

newRawValue - a new raw value to display in the cell

getDataAttributeQualifier

public 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. The data attribute qualifier is always appended to the data attribute name when trying to determine the DataCell to display. For example, if the data attribute name is "Sales" and the data attribute qualifier is "Boston", then the DataCell with a data attribute name of "Sales:Boston" will be rendered.

Returns:

the data attribute qualifier

setDataAttributeQualifier

public 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. The data attribute qualifier is always appended to the data attribute name when trying to determine the DataCell to display. For example, if the data attribute name is "Sales" and the data attribute qualifier is "Boston", then the DataCell with a data attribute name of "Sales:Boston" will be rendered.

Parameters:

dataAttributeQualifier - the data attribute qualifier

setCustomData

public 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 rendereed in data cells. To bind a stamped component ( a UIComponent rendered in a DataCell ) to custom data, the following EL can be used, #{varStatus.cellFormat.customData.customDataKey}.

Parameters:

customData - a map of custom data values

getCustomData

public 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 rendereed in data cells. To bind a stamped component ( a UIComponent rendered in a DataCell ) to custom data, the following EL can be used, #{varStatus.cellFormat.customData.customDataKey}.

Returns:

a map of custom data values