oracle.adf.view.faces.bi.component.pivotFilterBar
Class UIPivotFilterBar

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.pivotFilterBar.UIPivotFilterBar

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UIPivotFilterBar
extends org.apache.myfaces.trinidad.component.UIXComponentBase
implements javax.faces.component.NamingContainer, javax.faces.component.behavior.ClientBehaviorHolder

The PivotFilterBar component is used to filter data based on the selected criterion belonging to the PivotableQueryDescriptor as specified by the value property. The PivotFilterBar component is usually used along with the PivotTable component, in which case the PivotFilterBar is used to display the attributes of the page edge. When the PivotFilterBar component is associated with the PivotTable component, users will also be able to change the layout of the PivotTable by drag and drop pivoting between the PivotFilterBar and the PivotTable.

PivotFilterBar Features

PivotFilterBar Model

The PivotFilterBar component uses a model to display and interact with data. The specific model class to use is oracle.adf.view.faces.bi.model.PivotableQueryDescriptor. If pivoting is not required, then the oracle.adf.view.rich.model.QueryDescriptor could also be used instead.

Sizing

The inlineStyle attribute can be used to specify a PivotFilterBar's width and height. For example, inlineStyle="width:600px;height:400px".

Filter

The PivotFilterBar displays a list of filters based on the information from the model. A QueryListener will be notified after the value of one of the filters has changed.

Pivot

Pivot operations can be performed between a PivotTable and a PivotFilterBar if a PivotableQueryDescriptor is specified as the data model and provided the underlying data source (of the PivotTable, and in most cases it is the same as the PivotFilterBar) allows this operation. A QueryPivotListener will be notified after the operation is successfully performed.

Example

The following shows an example of using a PivotFilterBar component in conjunction with a PivotTable

 
    <dvt:pivotFilterBar id="pfb1" value="#{backingBean.queryDescriptor}" modelName="pivot1" /> 
    <dvt:pivotTable id="pt1" value="#{backingBean.dataModel}" modelName="pivot1" /> 
 
 

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static java.lang.String	CONTENT_DELIVERY_IMMEDIATE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_DELIVERY_KEY
static java.lang.String	CONTENT_DELIVERY_LAZY
static java.lang.String	CONTENT_DELIVERY_WHEN_AVAILABLE
static org.apache.myfaces.trinidad.bean.PropertyKey	DONT_PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FILTER_LABEL_VISIBLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MODEL_NAME_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	QUERY_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	QUERY_PIVOT_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SUMMARY_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_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

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIPivotFilterBar()
Constructs an instance of the UIPivotFilterBar.

UIPivotFilterBar(java.lang.String rendererType)
Constructs an instance of the UIPivotFilterBar.

Method Summary

void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
void	addQueryListener(oracle.adf.view.rich.event.QueryListener listener) Adds a QueryListener.
void	addQueryPivotListener(QueryPivotListener listener) Adds a QueryPivotListener.
void	broadcast(javax.faces.event.FacesEvent evt) Internal.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
oracle.adf.view.rich.event.ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getContentDelivery() Gets whether data should be fetched when the component is rendered initially.
java.lang.String	getDefaultEventName()
java.lang.String[]	getDontPersist() Gets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String	getLabel() Gets the label associated with the PivotFilterBar.
java.lang.String	getModelName() Gets the modelName of the PivotFilterBar.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String[]	getPersist() Gets a list of persistent attributes that are persisting to a registered "Persistent Change Manager".
javax.el.MethodExpression	getQueryListener() Gets a method reference to a QueryListener.
oracle.adf.view.rich.event.QueryListener[]	getQueryListeners() Returns an array of attached QueryListener objects.
javax.el.MethodExpression	getQueryPivotListener() Gets a method reference to a QueryPivotListener.
QueryPivotListener[]	getQueryPivotListeners() Returns an array of attached QueryPivotListener objects.
java.lang.String	getShortDesc() Gets the shortDesc value of the component.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.lang.String	getSummary() Gets the summary associated with the PivotFilterBar.
java.lang.Object	getValue() Gets the data model used by the PivotFilterBar.
boolean	isFilterLabelVisible() Gets the visibility of the PivotFilterBar's filter labels.
boolean	isVisible() Gets the visibility of the component.
void	removeQueryListener(oracle.adf.view.rich.event.QueryListener listener) Removes a QueryListener.
void	removeQueryPivotListener(QueryPivotListener listener) Removes a QueryPivotListener.
void	setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners) Sets a set of client listeners.
void	setContentDelivery(java.lang.String contentDelivery) Sets whether data should be fetched when the component is rendered initially.
void	setDontPersist(java.lang.String[] dontPersist) Sets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
void	setFilterLabelVisible(boolean filterLabelVisible) Sets the visibility of the PivotFilterBar's filter labels.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setLabel(java.lang.String label) Sets the label associated with the PivotFilterBar.
void	setModelName(java.lang.String modelName) Sets the modelName of the PivotFilterBar.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setPersist(java.lang.String[] persist) Sets a list of persistent attributes that are persisting to a registered "Persistent Change Manager".
void	setQueryListener(javax.el.MethodExpression queryListener) Sets a method reference to a QueryListener.
void	setQueryPivotListener(javax.el.MethodExpression queryPivotListener) Sets a method reference to a QueryPivotListener.
void	setShortDesc(java.lang.String desc) Sets the shortDesc value of the component.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setSummary(java.lang.String summary) Sets the summary associated with the PivotFilterBar.
void	setValue(java.lang.Object value) Sets the data model used by the PivotFilterBar.
void	setVisible(boolean visible) Sets the visibility of the component.

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

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

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

addPartialTarget, clearCachedClientIds, clearCachedClientIds, 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, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, 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

VALUE_KEY

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

CLIENT_LISTENERS_KEY

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

LABEL_KEY

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

MODEL_NAME_KEY

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

QUERY_LISTENER_KEY

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

QUERY_PIVOT_LISTENER_KEY

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

CONTENT_DELIVERY_KEY

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

FILTER_LABEL_VISIBLE_KEY

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

PERSIST_KEY

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

DONT_PERSIST_KEY

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

STYLE_CLASS_KEY

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

SHORT_DESC_KEY

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

INLINE_STYLE_KEY

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

VISIBLE_KEY

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

PARTIAL_TRIGGERS_KEY

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

SUMMARY_KEY

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

CONTENT_DELIVERY_IMMEDIATE

public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE

See Also:

Constant Field Values

CONTENT_DELIVERY_LAZY

public static final java.lang.String CONTENT_DELIVERY_LAZY

See Also:

Constant Field Values

CONTENT_DELIVERY_WHEN_AVAILABLE

public static final java.lang.String CONTENT_DELIVERY_WHEN_AVAILABLE

See Also:

Constant Field Values

Constructor Detail

UIPivotFilterBar

public UIPivotFilterBar()

Constructs an instance of the UIPivotFilterBar.

UIPivotFilterBar

public UIPivotFilterBar(java.lang.String rendererType)

Constructs an instance of the UIPivotFilterBar.

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily 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

getContentDelivery

public java.lang.String getContentDelivery()

Gets whether data should be fetched when the component is rendered initially. If contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request. If contentDelivery is set to "whenAvailable", upon initial rendering, the renderer queries the model for available data. Data is fetched and rendered immediately if the model indicates that data is available, or on a subsequent request if the model indicates otherwise. The default setting is "whenAvailable".

Returns:

the contentDelivery value.

setContentDelivery

public void setContentDelivery(java.lang.String contentDelivery)

Sets whether data should be fetched when the component is rendered initially. If contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request. If contentDelivery is set to "whenAvailable", upon initial rendering, the renderer queries the model for available data. Data is fetched and rendered immediately if the model indicates that data is available, or on a subsequent request if the model indicates otherwise. The default setting is "whenAvailable".

Parameters:

contentDelivery - the new contentDelivery value.

getValue

public java.lang.Object getValue()

Gets the data model used by the PivotFilterBar. It must be of type oracle.adf.view.rich.model.QueryDescriptor

Returns:

the value value.

setValue

public void setValue(java.lang.Object value)

Sets the data model used by the PivotFilterBar. It must be of type oracle.adf.view.rich.model.QueryDescriptor

Parameters:

value - the new value value.

setLabel

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

Sets the label associated with the PivotFilterBar. If null is specified then no label will be shown.

Parameters:

label - the new label value.

getLabel

public final java.lang.String getLabel()

Gets the label associated with the PivotFilterBar.

Returns:

the label value.

setSummary

public final void setSummary(java.lang.String summary)

Sets the summary associated with the PivotFilterBar.

Parameters:

summary - the new summary value.

getSummary

public final java.lang.String getSummary()

Gets the summary associated with the PivotFilterBar.

Returns:

the summary value.

setModelName

public final void setModelName(java.lang.String modelName)

Sets the modelName of the PivotFilterBar. The modelName is used to ensure that PivotFilterBar can only pivot with a PivotTable with an identical modelName.

Parameters:

modelName - the new modelName value.

getModelName

public final java.lang.String getModelName()

Gets the modelName of the PivotFilterBar. The model name is used to ensure that PivotFilterBar can only pivot with a PivotTable with an identical modelName.

Returns:

the modelName value.

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property. The default value is "true".

Returns:

the visible value.

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property. The default value is "true".

Parameters:

visible - the new visible value.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Returns:

the inlineStyle value.

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Parameters:

inlineStyle - the new inlineStyle value.

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component.

Returns:

the styleClass value.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component.

Parameters:

styleClass - the new styleClass value.

getShortDesc

public final java.lang.String getShortDesc()

Gets the shortDesc value of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

Returns:

the shortDesc value.

setShortDesc

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

Sets the shortDesc value of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

Parameters:

desc - the new shortDesc value.

getPersist

public final java.lang.String[] getPersist()

Gets a list of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.

Returns:

the persist value.

setPersist

public final void setPersist(java.lang.String[] persist)

Sets a list of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.

Parameters:

persist - the new persist value.

getDontPersist

public final java.lang.String[] getDontPersist()

Gets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.

Returns:

the dontPersist value.

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)

Sets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.

Parameters:

dontPersist - the new dontPersist value.

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the partialTriggers value.

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value.

getClientListeners

public final oracle.adf.view.rich.event.ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the clientListeners value.

setClientListeners

public final void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value.

getQueryListener

public final javax.el.MethodExpression getQueryListener()

Gets a method reference to a QueryListener.

Returns:

the queryListener value.

setQueryListener

public final void setQueryListener(javax.el.MethodExpression queryListener)

Sets a method reference to a QueryListener.

Parameters:

queryListener - the new queryListener value.

addQueryListener

public final void addQueryListener(oracle.adf.view.rich.event.QueryListener listener)

Adds a QueryListener.

Parameters:

listener - the QueryListener to add.

removeQueryListener

public final void removeQueryListener(oracle.adf.view.rich.event.QueryListener listener)

Removes a QueryListener.

Parameters:

listener - the QueryListener to remove.

getQueryListeners

public final oracle.adf.view.rich.event.QueryListener[] getQueryListeners()

Returns an array of attached QueryListener objects.

Returns:

an array of attached QueryListener objects.

getQueryPivotListener

public final javax.el.MethodExpression getQueryPivotListener()

Gets a method reference to a QueryPivotListener.

Returns:

the queryPivotListener value.

setQueryPivotListener

public final void setQueryPivotListener(javax.el.MethodExpression queryPivotListener)

Sets a method reference to a QueryPivotListener.

Parameters:

queryPivotListener - the new queryPivotListener value.

addQueryPivotListener

public final void addQueryPivotListener(QueryPivotListener listener)

Adds a QueryPivotListener.

Parameters:

listener - the QueryPivotListener to add.

removeQueryPivotListener

public final void removeQueryPivotListener(QueryPivotListener listener)

Removes a QueryPivotListener.

Parameters:

listener - the QueryPivotListener to remove.

getQueryPivotListeners

public final QueryPivotListener[] getQueryPivotListeners()

Returns an array of attached QueryPivotListener objects.

Returns:

an array of attached QueryPivotListener objects.

isFilterLabelVisible

public final boolean isFilterLabelVisible()

Gets the visibility of the PivotFilterBar's filter labels. The default value is "false".

Returns:

the filterLabelVisible value.

setFilterLabelVisible

public final void setFilterLabelVisible(boolean filterLabelVisible)

Sets the visibility of the PivotFilterBar's filter labels. The default value is "false".

Parameters:

filterLabelVisible - the new filterLabelVisible value.

broadcast

public void broadcast(javax.faces.event.FacesEvent evt)

Internal. Application should never call this method directly.

Overrides:

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

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

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

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()

Specified by:

getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

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

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

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