|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 1 (11.1.1.4.0) E12063-05 |
||||||||
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 Pivot Table component, in which case the PivotFilterBar is used to display the attributes of the page edge. When the PivotFilterBar component is associated with the Pivot Table component, users will also be able to change the layout of the Pivot Table by drag and drop pivoting between the PivotFilterBar and the Pivot Table.
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.PivotableQuerDescriptor
.
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" or inlineStyle="width:100%;height:400px".
The PivotFilterBar displays a list of filters based on the information from the model. A query listener will be notified after the vlaue of one of the filters has changed.
Pivot operation can be performed between a Pivot Table and a PivotFilterBar if a PivotableQueryDescriptor is specified as the data model and provided the underlying data source (of the Pivot Table, and in most cases it is the same as the PivotFilterBar) allows this operation. A query pivot listener will be notified after the operation is successfully performed.
The following shows an example of using PivotFilterBar component used in conjunction with a Pivot Table
<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 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 |
---|
bindings |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
UIPivotFilterBar()
|
|
UIPivotFilterBar(java.lang.String family)
|
Method Summary | |
---|---|
void |
addQueryListener(oracle.adf.view.rich.event.QueryListener listener)
Adds a query listener. |
void |
addQueryPivotListener(QueryPivotListener listener)
Adds a query pivot listener. |
void |
broadcast(javax.faces.event.FacesEvent evt)
Internal. |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType()
|
oracle.adf.view.rich.event.ClientListenerSet |
getClientListeners()
Gets a set of client listeners. |
java.lang.String |
getContentDelivery()
Gets whether the content of the PivotFilterBar is delivered with the initial page. |
java.lang.String[] |
getDontPersist()
Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". |
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 model name of the PivotFilterBar. |
java.lang.String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. |
java.lang.String[] |
getPersist()
Gets List of persistent attributes that are persisting to a registered "Persistent Change Manager". |
javax.el.MethodExpression |
getQueryListener()
Gets a method reference to a query listener. |
oracle.adf.view.rich.event.QueryListener[] |
getQueryListeners()
Returns an array of attached query listeners. |
javax.el.MethodExpression |
getQueryPivotListener()
Gets a method reference to a query pivot listener. |
QueryPivotListener[] |
getQueryPivotListeners()
Returns an array of attached query pivot listeners. |
java.lang.String |
getRendererType()
|
java.lang.String |
getShortDesc()
Gets the short description 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 model used by the PivotFilterBar. |
boolean |
isFilterLabelVisible()
Whether the PivotFilterBar's filter labels are visible. |
boolean |
isVisible()
Whether the PivotFilterBar is visible. |
void |
removeQueryListener(oracle.adf.view.rich.event.QueryListener listener)
Removes a query listener. |
void |
removeQueryPivotListener(QueryPivotListener listener)
Removes a query pivot listener. |
void |
setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)
Sets a set of client listeners. |
void |
setContentDelivery(java.lang.String contentDelivery)
Sets whether the content of the PivotFilterBar is delivered with the initial page. |
void |
setDontPersist(java.lang.String[] dontPersist)
Sets 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 model name 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 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 query listener. |
void |
setQueryPivotListener(javax.el.MethodExpression queryPivotListener)
Sets a method reference to a query pivot listener. |
void |
setShortDesc(java.lang.String desc)
Sets the short description 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 model used by the PivotFilterBar. |
void |
setVisible(boolean visible)
Sets the visibility of the PivotFilterBar. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, 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, getParent, getProperty, getPropertyKey, getRenderer, getRendersChildren, getValueBinding, getValueExpression, 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, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
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
Constructor Detail |
---|
public UIPivotFilterBar()
public UIPivotFilterBar(java.lang.String family)
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.lang.String getRendererType()
getRendererType
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
- 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 model used by the PivotFilterBar.public final void setLabel(java.lang.String label)
label
- the label associated with the PivotFilterBar.public final java.lang.String getLabel()
public final void setSummary(java.lang.String summary)
summary
- the summary associated with the PivotFilterBar.public final java.lang.String getSummary()
public final void setModelName(java.lang.String modelName)
modelName
- the model name of the PivotFilterBar.public final java.lang.String getModelName()
public final boolean isVisible()
true
if the PivotFilterBar is visible. false
otherwise.public final void setVisible(boolean visible)
visible
- true
to set the PivotFilterBar visible. false
otherwise.public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String desc)
the
- short description of the component.public final java.lang.String[] getPersist()
public final void setPersist(java.lang.String[] persist)
persist
- the new persist valuepublic final java.lang.String[] getDontPersist()
public final void setDontPersist(java.lang.String[] dontPersist)
dontPersist
- the new dontPersist valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic 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)
public final void addQueryListener(oracle.adf.view.rich.event.QueryListener listener)
listener
- the query listener to add.public final void removeQueryListener(oracle.adf.view.rich.event.QueryListener listener)
listener
- the query listener 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)
public final void addQueryPivotListener(QueryPivotListener listener)
listener
- the query pivot listener to add.public final void removeQueryPivotListener(QueryPivotListener listener)
listener
- the query pivot listener to remove.public final QueryPivotListener[] getQueryPivotListeners()
public final boolean isFilterLabelVisible()
true
if the PivotFilterBar's filter labels are visible. false
otherwise.public final void setFilterLabelVisible(boolean filterLabelVisible)
filterLabelVisible
- true
to set the PivotFilterBar's filter labels visible. false
otherwise.public void broadcast(javax.faces.event.FacesEvent evt)
broadcast
in class org.apache.myfaces.trinidad.component.UIXComponentBase
evt
-
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 1 (11.1.1.4.0) E12063-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |