oracle.adf.view.faces.bi.component.attributeGroups

Class UIAttributeGroups

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.attributeGroups.UIAttributeGroups

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 UIAttributeGroups
extends org.apache.myfaces.trinidad.component.UIXComponentBase

The Attribute Groups component is used to generate stylistic attribute values such as colors or shapes based on categorical or continuous bucketing of a data set. Given the column in the model to group by, the Attribute Groups can produce style values for each unique value ("group") in the data.

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 java.lang.String	ATTRIBUTE_GROUP_TYPE_COLOR
static java.lang.String	ATTRIBUTE_GROUP_TYPE_OPACITY
static java.lang.String	ATTRIBUTE_GROUP_TYPE_PATTERN
static java.lang.String	ATTRIBUTE_GROUP_TYPE_SCALEX
static java.lang.String	ATTRIBUTE_GROUP_TYPE_SCALEY
static java.lang.String	ATTRIBUTE_GROUP_TYPE_SHAPE
static java.lang.String	ATTRIBUTE_GROUP_TYPE_SHAPE_PATH
static org.apache.myfaces.trinidad.bean.PropertyKey	ATTRIBUTE_PROVIDER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ATTRIBUTE_TYPE_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	DISCRIMINANT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAX_LABEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAX_VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MIN_LABEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MIN_VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SECTION_LABEL_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	TYPE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VALUE_KEY

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
UIAttributeGroups() Constructs an instance of UIAttributeGroups

Method Summary

Modifier and Type	Method and Description
AttributeProvider	getAttributeProvider() Gets a reference to an AttributeProvider instance to be used to dynamically assign attribute mappings at runtime.
java.lang.String	getAttributeType() Returns the attribute type to generate values for.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getDiscriminant() Returns the discriminant of this component.
java.lang.String	getFamily()
java.lang.String	getLabel() Gets the text label for this component
java.lang.Object	getMaxLabel() Returns the label for the maximum bounds of this component.
java.lang.Object	getMaxValue() Returns the maximum bounds of this component.
java.lang.Object	getMinLabel() Returns the label for the minimum bounds of this component.
java.lang.Object	getMinValue() Returns the minimum bounds of this component.
java.lang.String	getRendererType()
java.lang.String	getSectionLabel() Gets the section label for this component
java.lang.String	getType() Gets the space-delimited list of stylistic attribute types to generate values for.
java.lang.String	getValue() Gets the value from the data model to group by
void	setAttributeProvider(AttributeProvider attributeProvider) Sets a reference to an AttributeProvider instance to be used to dynamically assign attribute mappings at runtime.
void	setAttributeType(java.lang.String attributeType) Specifies the attribute type to generate values for.
void	setDiscriminant(java.lang.Object value) Specifies the discriminant of this component.
void	setLabel(java.lang.String label) Sets the text label for this component
void	setMaxLabel(java.lang.Object value) Specifies the label for the maximum bounds of this component.
void	setMaxValue(java.lang.Object value) Specifies the maximum bounds of this component.
void	setMinLabel(java.lang.Object value) Specifies the label for the minimum bounds of this component.
void	setMinValue(java.lang.Object value) Specifies the minimum bounds of this component.
void	setSectionLabel(java.lang.String sectionLabel) Sets the section label for this component
void	setType(java.lang.String type) Sets the stylistic attribute types to generate values for.
void	setValue(java.lang.String value) Sets the value from the data model to group by

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

ATTRIBUTE_TYPE_KEY

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

LABEL_KEY

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

SECTION_LABEL_KEY

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

MIN_LABEL_KEY

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

MAX_LABEL_KEY

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

MIN_VALUE_KEY

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

MAX_VALUE_KEY

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

VALUE_KEY

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

TYPE_KEY

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

DISCRIMINANT_KEY

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

ATTRIBUTE_PROVIDER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ATTRIBUTE_PROVIDER_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

ATTRIBUTE_GROUP_TYPE_SHAPE

public static final java.lang.String ATTRIBUTE_GROUP_TYPE_SHAPE

See Also:

Constant Field Values

ATTRIBUTE_GROUP_TYPE_SHAPE_PATH

public static final java.lang.String ATTRIBUTE_GROUP_TYPE_SHAPE_PATH

See Also:

Constant Field Values

ATTRIBUTE_GROUP_TYPE_COLOR

public static final java.lang.String ATTRIBUTE_GROUP_TYPE_COLOR

See Also:

Constant Field Values

ATTRIBUTE_GROUP_TYPE_SCALEX

public static final java.lang.String ATTRIBUTE_GROUP_TYPE_SCALEX

See Also:

Constant Field Values

ATTRIBUTE_GROUP_TYPE_SCALEY

public static final java.lang.String ATTRIBUTE_GROUP_TYPE_SCALEY

See Also:

Constant Field Values

ATTRIBUTE_GROUP_TYPE_OPACITY

public static final java.lang.String ATTRIBUTE_GROUP_TYPE_OPACITY

See Also:

Constant Field Values

ATTRIBUTE_GROUP_TYPE_PATTERN

public static final java.lang.String ATTRIBUTE_GROUP_TYPE_PATTERN

See Also:

Constant Field Values

Constructor Detail

UIAttributeGroups

public UIAttributeGroups()

Constructs an instance of UIAttributeGroups

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

getValue

public final java.lang.String getValue()

Gets the value from the data model to group by

Returns:

the value to group by

setValue

public final void setValue(java.lang.String value)

Sets the value from the data model to group by

Parameters:

value - the value to group by

getLabel

public final java.lang.String getLabel()

Gets the text label for this component

Returns:

text label

setLabel

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

Sets the text label for this component

Parameters:

label - text label

getSectionLabel

public final java.lang.String getSectionLabel()

Gets the section label for this component

Returns:

section label

setSectionLabel

public final void setSectionLabel(java.lang.String sectionLabel)

Sets the section label for this component

Parameters:

sectionLabel - section label

getType

public final java.lang.String getType()

Gets the space-delimited list of stylistic attribute types to generate values for. Valid values are: "shape", "color", "pattern", "opacity", "scaleX", "scaleY"

Returns:

the stylistic attribute types to generate values for

setType

public final void setType(java.lang.String type)

Sets the stylistic attribute types to generate values for. Valid values are: "shape", "color", "pattern", "opacity", "scaleX", "scaleY"

Parameters:

type - the stylistic attribute types to generate values for

getAttributeType

public final java.lang.String getAttributeType()

Returns the attribute type to generate values for. Valid values are "discrete" (default) and "continuous".

setAttributeType

public final void setAttributeType(java.lang.String attributeType)

Specifies the attribute type to generate values for. Valid values are "discrete" (default) and "continuous".

getMinLabel

public final java.lang.Object getMinLabel()

Returns the label for the minimum bounds of this component. This value only applies when the attribute type is "continuous". If no value is specified, the minimum data value will be used instead.

setMinLabel

public final void setMinLabel(java.lang.Object value)

Specifies the label for the minimum bounds of this component. This value only applies when the attribute type is "continuous". If no value is specified, the minimum data value will be used instead.

getMaxLabel

public final java.lang.Object getMaxLabel()

Returns the label for the maximum bounds of this component. This value only applies when the attribute type is "continuous". If no value is specified, the maximum data value will be used instead.

setMaxLabel

public final void setMaxLabel(java.lang.Object value)

Specifies the label for the maximum bounds of this component. This value only applies when the attribute type is "continuous". If no value is specified, the maximum data value will be used instead.

getMinValue

public final java.lang.Object getMinValue()

Returns the minimum bounds of this component. This value only applies when the attribute type is "continuous". If no value is specified, the minimum data value will be used instead.

setMinValue

public final void setMinValue(java.lang.Object value)

Specifies the minimum bounds of this component. This value only applies when the attribute type is "continuous". If no value is specified, the minimum data value will be used instead.

getMaxValue

public final java.lang.Object getMaxValue()

Returns the maximum bounds of this component. This value only applies when the attribute type is "continuous". If no value is specified, the maximum data value will be used instead.

setMaxValue

public final void setMaxValue(java.lang.Object value)

Specifies the maximum bounds of this component. This value only applies when the attribute type is "continuous". If no value is specified, the maximum data value will be used instead.

getDiscriminant

public java.lang.String getDiscriminant()

Returns the discriminant of this component. This optional value allows components on the same page using attribute groups to share attribute groupings by setting identical discriminant values. Components with no discriminant specified will not share groupings with any other component. Discriminants are visible across the current window instance, so applications must ensure that they are unique (e.g. by qualifying them with the region id or page name).

setDiscriminant

public final void setDiscriminant(java.lang.Object value)

Specifies the discriminant of this component. This optional value allows components on the same page using attribute groups to share attribute groupings by setting identical discriminant values. Components with no discriminant specified will not share groupings with any other component. Discriminants are visible across the current window instance, so applications must ensure that they are unique (e.g. by qualifying them with the region id or page name).

getAttributeProvider

public final AttributeProvider getAttributeProvider()

Gets a reference to an AttributeProvider instance to be used to dynamically assign attribute mappings at runtime. This instance will only be used for group values that have not already been mapped. The discriminant attribute can still be used to control the sharing of attribute groupings.

Returns:

the AttributeProvider

setAttributeProvider

public final void setAttributeProvider(AttributeProvider attributeProvider)

Sets a reference to an AttributeProvider instance to be used to dynamically assign attribute mappings at runtime. This instance will only be used for group values that have not already been mapped. The discriminant attribute can still be used to control the sharing of attribute groupings.

Parameters:

attributeProvider - the AttributeProvider