oracle.adfdt.view.dvt.binding.pattern.nBox.extension

Class NBoxCellExtendedProperties

java.lang.Object

oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

oracle.adfdt.view.dvt.binding.pattern.nBox.extension.NBoxCellExtendedProperties

All Implemented Interfaces:

ExtendedProperties

public class NBoxCellExtendedProperties
extends ComplexExtendedProperties

A set of accessor methods that allow the user to change the structure and functionality of a nBoxCell.

Field Summary

Fields inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

AF_NS, DVT_NS, F_NS

Constructor Summary

Constructors

Constructor and Description
NBoxCellExtendedProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBackground() Description: Specifies the background for this cell.
java.lang.String	getBinding() Description: Specifies a binding reference to store a specific instance of UINBoxCell from a backing bean.
java.lang.String	getColumn() Description: Specifies the column for this cell.
java.lang.String	getCountLabel() Description: Specifies the text for the cell count label (extra info displayed after primary cell label).
java.lang.String	getId() Description: Specifies the identifier for the component
java.lang.String	getLabel() Description: Specifies the label for this cell.
java.lang.String	getLabelHalign() Description: Specifies the halign for this cell label.
java.lang.String	getLabelStyle() Description: Specifies the font style for the label of this cell.
java.lang.String	getRow() Description: Specifies the row for this cell.
java.lang.String	getShortDesc() Description: Specifies the description for the cell.
java.lang.String	getShowCount() Description: Determines when to display the cell count label (extra info displayed after primary cell label).
java.lang.String	getTagName()
boolean	isRendered() Description: Specifies whether the component is rendered.
java.lang.String	isRenderedAsString() Description: Specifies whether the component is rendered.
void	setBackground(java.lang.String background) Description: Specifies the background for this cell.
void	setBinding(java.lang.String binding) Description: Specifies a binding reference to store a specific instance of UINBoxCell from a backing bean.
void	setColumn(java.lang.String column) Description: Specifies the column for this cell.
void	setCountLabel(java.lang.String countLabel) Description: Specifies the text for the cell count label (extra info displayed after primary cell label).
void	setId(java.lang.String id) Description: Specifies the identifier for the component
void	setLabel(java.lang.String label) Description: Specifies the label for this cell.
void	setLabelHalign(java.lang.String labelHalign) Description: Specifies the halign for this cell label.
void	setLabelStyle(java.lang.String labelStyle) Description: Specifies the font style for the label of this cell.
void	setRendered(boolean rendered) Description: Specifies whether the component is rendered.
void	setRenderedAsString(java.lang.String rendered) Description: Specifies whether the component is rendered.
void	setRow(java.lang.String row) Description: Specifies the row for this cell.
void	setShortDesc(java.lang.String shortDesc) Description: Specifies the description for the cell.
void	setShowCount(java.lang.String showCount) Description: Determines when to display the cell count label (extra info displayed after primary cell label).

Methods inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

_applyToRootElement, _applyToRootElement, applyChanges, applyChanges, applyChanges, applyChanges, applyChanges, cloneFrom, getAttribute, getComplexChild, getComplexChild, getComplexChildAsList, populateAttributesAndChildTags, removeComplexChildList, setAttribute, setComplexChild, setComplexChild, setComplexChildAsList

Methods inherited from class java.lang.Object

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

Constructor Detail

NBoxCellExtendedProperties

public NBoxCellExtendedProperties()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getBackground

public java.lang.String getBackground()

Description: Specifies the background for this cell. Can be a color (e.g. "#aaaaaa") or gradient (e.g. "linear-gradient(0deg, black, white)").

Returns:

the value of the background attribute of the Tag this class represents.

setBackground

public void setBackground(java.lang.String background)

Description: Specifies the background for this cell. Can be a color (e.g. "#aaaaaa") or gradient (e.g. "linear-gradient(0deg, black, white)").

Parameters:

background - the value of the background attribute of the Tag this class represents.

getBinding

public java.lang.String getBinding()

Description: Specifies a binding reference to store a specific instance of UINBoxCell from a backing bean. Set this attribute only to access code in a backing bean.

Returns:

the value of the binding attribute of the Tag this class represents.

setBinding

public void setBinding(java.lang.String binding)

Description: Specifies a binding reference to store a specific instance of UINBoxCell from a backing bean. Set this attribute only to access code in a backing bean.

Parameters:

binding - the value of the binding attribute of the Tag this class represents.

getColumn

public java.lang.String getColumn()

Description: Specifies the column for this cell. Must correspond to the value attribute of a dvt:nBoxColumn

Returns:

the value of the column attribute of the Tag this class represents.

setColumn

public void setColumn(java.lang.String column)

Description: Specifies the column for this cell. Must correspond to the value attribute of a dvt:nBoxColumn

Parameters:

column - the value of the column attribute of the Tag this class represents.

getCountLabel

public java.lang.String getCountLabel()

Description: Specifies the text for the cell count label (extra info displayed after primary cell label). By default, this label shows a simple count of nodes in the cell, but can be customized using this attribute. Custom count labels are shown when showCount is set "on" or "auto".

Returns:

the value of the countLabel attribute of the Tag this class represents.

setCountLabel

public void setCountLabel(java.lang.String countLabel)

Description: Specifies the text for the cell count label (extra info displayed after primary cell label). By default, this label shows a simple count of nodes in the cell, but can be customized using this attribute. Custom count labels are shown when showCount is set "on" or "auto".

Parameters:

countLabel - the value of the countLabel attribute of the Tag this class represents.

getId

public java.lang.String getId()

Description: Specifies the identifier for the component

Returns:

the value of the id attribute of the Tag this class represents.

setId

public void setId(java.lang.String id)

Description: Specifies the identifier for the component

Parameters:

id - the value of the id attribute of the Tag this class represents.

getLabel

public java.lang.String getLabel()

Description: Specifies the label for this cell.

Returns:

the value of the label attribute of the Tag this class represents.

setLabel

public void setLabel(java.lang.String label)

Description: Specifies the label for this cell.

Parameters:

label - the value of the label attribute of the Tag this class represents.

getLabelHalign

public java.lang.String getLabelHalign()

Description: Specifies the halign for this cell label.

Returns:

the value of the labelHalign attribute of the Tag this class represents.

setLabelHalign

public void setLabelHalign(java.lang.String labelHalign)

Description: Specifies the halign for this cell label.

Parameters:

labelHalign - the value of the labelHalign attribute of the Tag this class represents.

getLabelStyle

public java.lang.String getLabelStyle()

Description: Specifies the font style for the label of this cell. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.

Returns:

the value of the labelStyle attribute of the Tag this class represents.

setLabelStyle

public void setLabelStyle(java.lang.String labelStyle)

Description: Specifies the font style for the label of this cell. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.

Parameters:

labelStyle - the value of the labelStyle attribute of the Tag this class represents.

isRendered

public boolean isRendered()

Description: Specifies whether the component is rendered.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRendered

public void setRendered(boolean rendered)

Description: Specifies whether the component is rendered.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

isRenderedAsString

public java.lang.String isRenderedAsString()

Description: Specifies whether the component is rendered. This method is provided as a convenience to be able to retrieve an EL that was set on the rendered attribute.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRenderedAsString

public void setRenderedAsString(java.lang.String rendered)

Description: Specifies whether the component is rendered. This method is provided as a convenience to be able to set an EL on the rendered attribute.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

getRow

public java.lang.String getRow()

Description: Specifies the row for this cell. Must correspond to the value attribute of a dvt:nBoxRow

Returns:

the value of the row attribute of the Tag this class represents.

setRow

public void setRow(java.lang.String row)

Description: Specifies the row for this cell. Must correspond to the value attribute of a dvt:nBoxRow

Parameters:

row - the value of the row attribute of the Tag this class represents.

getShortDesc

public java.lang.String getShortDesc()

Description: Specifies the description for the cell. This is used for the accessibility feature.

Returns:

the value of the shortDesc attribute of the Tag this class represents.

setShortDesc

public void setShortDesc(java.lang.String shortDesc)

Description: Specifies the description for the cell. This is used for the accessibility feature.

Parameters:

shortDesc - the value of the shortDesc attribute of the Tag this class represents.

getShowCount

public java.lang.String getShowCount()

Description: Determines when to display the cell count label (extra info displayed after primary cell label). When "off", never show the count label. When "auto", show the count label only when countLabel is specified. When "on", always show the count label. If countLabel is not specified, display a simple node count.

Returns:

the value of the showCount attribute of the Tag this class represents.

setShowCount

public void setShowCount(java.lang.String showCount)

Description: Determines when to display the cell count label (extra info displayed after primary cell label). When "off", never show the count label. When "auto", show the count label only when countLabel is specified. When "on", always show the count label. If countLabel is not specified, display a simple node count.

Parameters:

showCount - the value of the showCount attribute of the Tag this class represents.