oracle.adf.view.faces.bi.component.nBox

Class UINBoxCell

java.lang.Object

javax.faces.component.UIComponent

org.apache.myfaces.trinidad.component.UIXComponent

org.apache.myfaces.trinidad.component.UIXComponentBase

oracle.adf.view.faces.bi.component.nBox.UINBoxCell

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UINBoxCell
extends org.apache.myfaces.trinidad.component.UIXComponentBase

Since:

release specific (what release of product did this appear in)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	BACKGROUND_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLUMN_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	COUNT_LABEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_HALIGN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOW_COUNT_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UINBoxCell()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBackground() Returns the background for this cell.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getColumn() Returns the column that this cell belongs in.
java.lang.String	getCountLabel() Returns the count label for this cell.
java.lang.String	getFamily()
java.lang.String	getLabel() Returns the label for this cell.
java.lang.String	getLabelHalign() Returns the halign for the cell label.
java.lang.String	getLabelStyle() Returns the font style for the label of this cell.
java.lang.String	getRendererType()
java.lang.String	getRow() Returns the row that this cell belongs in.
java.lang.String	getShortDesc() Gets the description for the cell.
java.lang.String	getShowCount() Gets the display behavior of the cell count label.
void	setBackground(java.lang.String background) Sets the background for this cell.
void	setColumn(java.lang.String column) Sets the column that this cell belongs in.
void	setCountLabel(java.lang.String countLabel) Sets the count label for this cell.
void	setLabel(java.lang.String label) Specifies the label for this cell.
void	setLabelHalign(java.lang.String halign) Sets the halign for the cell label.
void	setLabelStyle(java.lang.String labelStyle) Sets the font style for the label of this cell.
void	setRow(java.lang.String row) Sets the row that this cell belongs in.
void	setShortDesc(java.lang.String shortDesc) Sets the description for the cell.
void	setShowCount(java.lang.String showCount) Sets the display behavior of the cell count label.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

BACKGROUND_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey BACKGROUND_KEY

COLUMN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_KEY

COUNT_LABEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey COUNT_LABEL_KEY

LABEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY

LABEL_HALIGN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_HALIGN_KEY

LABEL_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_STYLE_KEY

ROW_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_KEY

SHOW_COUNT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_COUNT_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UINBoxCell

public UINBoxCell()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

getRendererType

public java.lang.String getRendererType()

Overrides:

getRendererType in class org.apache.myfaces.trinidad.component.UIXComponentBase

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase

getBackground

public final java.lang.String getBackground()

Returns the background for this cell. Can be a color (e.g. "#aaaaaa") , gradient (e.g. "linear-gradient(0deg, black, white)), or an image (e.g. "url(background.png)")

Returns:

the background for this cell

setBackground

public final void setBackground(java.lang.String background)

Sets the background for this cell. Can be a color (e.g. "#aaaaaa") , gradient (e.g. "linear-gradient(0deg, black, white)), or an image (e.g. "url(background.png)")

Parameters:

background - the background for this cell

getColumn

public final java.lang.String getColumn()

Returns the column that this cell belongs in.

Returns:

the column that this cell belongs in.

See Also:

UINBoxColumn.getValue()

setColumn

public final void setColumn(java.lang.String column)

Sets the column that this cell belongs in.

Parameters:

column - the column that this cell belongs in.

See Also:

UINBoxColumn.getValue()

getCountLabel

public final java.lang.String getCountLabel()

Returns the count label for this cell.

Returns:

the count label for this cell.

setCountLabel

public final void setCountLabel(java.lang.String countLabel)

Sets the count label for this cell.

Parameters:

countLabel - the count label for this cell.

getLabel

public final java.lang.String getLabel()

Returns the label for this cell.

Returns:

the label for this cell

setLabel

public final void setLabel(java.lang.String label)

Specifies the label for this cell.

Parameters:

label - the label for this cell

getLabelHalign

public final java.lang.String getLabelHalign()

Returns the halign for the cell label. Valid values are "start" (default), "center", and "end".

Returns:

the halign for the cell label

setLabelHalign

public final void setLabelHalign(java.lang.String halign)

Sets the halign for the cell label. Valid values are "start" (default), "center", and "end".

Parameters:

halign - the halign for the cell label

getLabelStyle

public final java.lang.String getLabelStyle()

Returns 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 font style for the label of this cell

setLabelStyle

public final void setLabelStyle(java.lang.String labelStyle)

Sets 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 font style for the label of this cell

getRow

public final java.lang.String getRow()

Returns the row that this cell belongs in.

Returns:

the row that this cell belongs in.

See Also:

UINBoxRow.getValue()

setRow

public final void setRow(java.lang.String row)

Sets the row that this cell belongs in.

Parameters:

row - the row that this cell belongs in.

See Also:

UINBoxRow.getValue()

getShowCount

public final java.lang.String getShowCount()

Gets the display behavior of the cell count label. The count label appears after the primary cell label, and is never shown unless a primary label has been defined. By default, the count label provides a simple count of nodes in the cell, but can be customized using the countLabel attribute. Valid values: "on" - always show count label. "off" - never show count label. "auto" (default) - show only if custom label has been defined via countLabel attribute.

Returns:

display behavior of the cell count label

setShowCount

public final void setShowCount(java.lang.String showCount)

Sets the display behavior of the cell count label. The count label appears after the primary cell label, and is never shown unless a primary label has been defined. By default, the count label provides a simple count of nodes in the cell, but can be customized using the countLabel attribute. Valid values: "on" - always show count label. "off" - never show count label. "auto" (default) - show only if custom label has been defined via countLabel attribute.

Parameters:

showCount - display behavior of the cell count label

getShortDesc

public final java.lang.String getShortDesc()

Gets the description for the cell. This is used for accessibility.

Returns:

the description for the cell.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the description for the cell. This is used for accessibility.

Parameters:

shortDesc - the description for the cell.