|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class UIPivotFilterBar
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.
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.
The inlineStyle attribute can be used to specify a PivotFilterBar's width and height. For example, inlineStyle="width:600px;height:400px".
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 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.
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, getRenderedFacetsAndChildren, 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 |
---|
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MODEL_NAME_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey QUERY_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey QUERY_PIVOT_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey FILTER_LABEL_VISIBLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SUMMARY_KEY
public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE
public static final java.lang.String CONTENT_DELIVERY_LAZY
public static final java.lang.String CONTENT_DELIVERY_WHEN_AVAILABLE
Constructor Detail |
---|
public UIPivotFilterBar()
public UIPivotFilterBar(java.lang.String rendererType)
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXComponentBase
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.lang.String getContentDelivery()
public void setContentDelivery(java.lang.String contentDelivery)
contentDelivery
- the new contentDelivery value.public java.lang.Object getValue()
oracle.adf.view.rich.model.QueryDescriptor
public void setValue(java.lang.Object value)
oracle.adf.view.rich.model.QueryDescriptor
value
- the new value value.public final void setLabel(java.lang.String label)
label
- the new label value.public final java.lang.String getLabel()
public final void setSummary(java.lang.String summary)
summary
- the new summary value.public final java.lang.String getSummary()
public final void setModelName(java.lang.String modelName)
modelName
- the new modelName value.public final java.lang.String getModelName()
public final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value.public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle value.public final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass value.public final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String desc)
desc
- the new shortDesc value.public final java.lang.String[] getPersist()
public final void setPersist(java.lang.String[] persist)
persist
- the new persist value.public final java.lang.String[] getDontPersist()
public final void setDontPersist(java.lang.String[] dontPersist)
dontPersist
- the new dontPersist value.public final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers value.public final oracle.adf.view.rich.event.ClientListenerSet getClientListeners()
public final void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)
clientListeners
- the new clientListeners value.public final javax.el.MethodExpression getQueryListener()
public final void setQueryListener(javax.el.MethodExpression queryListener)
queryListener
- the new queryListener value.public final void addQueryListener(oracle.adf.view.rich.event.QueryListener listener)
listener
- the QueryListener to add.public final void removeQueryListener(oracle.adf.view.rich.event.QueryListener listener)
listener
- the QueryListener to remove.public final oracle.adf.view.rich.event.QueryListener[] getQueryListeners()
public final javax.el.MethodExpression getQueryPivotListener()
public final void setQueryPivotListener(javax.el.MethodExpression queryPivotListener)
queryPivotListener
- the new queryPivotListener value.public final void addQueryPivotListener(QueryPivotListener listener)
listener
- the QueryPivotListener to add.public final void removeQueryPivotListener(QueryPivotListener listener)
listener
- the QueryPivotListener to remove.public final QueryPivotListener[] getQueryPivotListeners()
public final boolean isFilterLabelVisible()
public final void setFilterLabelVisible(boolean filterLabelVisible)
filterLabelVisible
- the new filterLabelVisible value.public void broadcast(javax.faces.event.FacesEvent evt)
broadcast
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |