Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.0)
E12418-09

<dvt:pivotFilterBar>

dvt:pivotFilterBar pivotFilterBar pivot filter bar

UIComponent class: oracle.adf.view.faces.bi.component.pivotFilterBar.UIPivotFilterBar
Component type: oracle.dss.adf.pivotFilterBar.PivotFilterBar

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.

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.PivotableQuerDescriptor. 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" or inlineStyle="width:100%;height:400px".

Filter

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

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.

Attachment Mode

In attachment mode, content delivery is forced to immediate. The current value of each filter is displayed, but cannot be changed. The ability to pivot with a Pivot Table is also not supported.

Child Tags

Example

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" />

Events

Type Phases Description
oracle.adf.view.faces.bi.event.QueryPivotEvent Invoke Application The query pivot event is delivered when a pivot is performed on the PivotFilterBar.
oracle.adf.view.rich.event.QueryEvent Invoke Application The query event is delivered when the value of one of the filters has changed.
org.apache.myfaces.trinidad.event.AttributeChangeEvent Invoke Application,
Apply Request Values		 Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Attributes

Name Type Supports EL? Description
attributeChangeListener javax.el.MethodExpression Only EL a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
binding String Only EL binding reference to store the UIPivotFilterBar component
contentDelivery String Yes whether the content of the PivotFilterBar is delivered with the initial page. When content delivery is set to 'lazy', the filters within the PivotFilterBar are not rendered when the page is first loaded. The default setting is 'immediate'.
dontPersist String Yes List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.
filterLabelVisible boolean Yes the visibility of the PivotFilterBar's filter labels. If set to "true", the labels for each filter will be shown. The default value is false.
id String No the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
inlineStyle String Yes The inline style of the PivotFilterBar's outer DOM element.
label String Yes the label associated with the PivotFilterBar. If null is specified then no label would be shown.
modelName String Yes The model name of the PivotFilterBar. The model name is used to ensure that this PivotFilterBar can only pivot with a Pivot Table with the same model name.
partialTriggers String Yes The IDs of the components that should trigger a partial update for pivot table. 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.
persist String Yes List of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.
queryListener String Yes a method reference to a query listener that will be called when the value of one of the filters has changed.
queryPivotListener String Yes A method reference to a query pivot listener that will be called after a pivot operation is performed on the PivotFilterBar.
rendered boolean Yes Specifies whether the component is rendered. The default value is true.
shortDesc String Yes Sets a short description of this component's purpose and structure for user agents rendering to non-visual media (e.g. screen readers).
styleClass String Yes Sets a CSS style class to use for this component.
summary String Yes Sets a summary of this PivotFilterBar's purpose and structure for user agents rendering to non-visual media (e.g. screen readers).
value String Yes the data model for the PivotFilterBar - can be an instance of oracle.adf.view.faces.bi.model.PivotableQueryDescriptor or oracle.adf.view.rich.model.QueryDescriptor. if the latter is specified then pivoting is disabled.
visible boolean Yes 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. The default value is true.