Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces
12c (12.2.1)
E52773-01

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

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.

Geometry Management

This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout, panelSplitter
This component does not stretch to fill up the browser's viewport when it is the "sole visual root component" in the component tree.
When NOT stretched, this component will be displayed in its default dimensions which are provided by the skin. This can be modified by applying a dimension using the inlineStyle or styleClass attributes.
This component does not stretch its filters. The filters instead re-arrange themselves to fit the available space accordingly.

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

Screen Shot(s)

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 event 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	Valid Values: lazy, immediate, whenAvailable Default Value: whenAvailable 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".
dontPersist	String[]	Yes	A list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".
filterLabelVisible	boolean	Yes	Default Value: false 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	Specifies the identifier for the component.
inlineStyle	String	Yes	The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
label	String	Yes	The label associated with the PivotFilterBar. If null is specified then no label will 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 PivotTable with the same model name.
partialTriggers	String[]	Yes	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.
persist	String[]	Yes	A list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.
queryListener	javax.el.MethodExpression	Only EL	A method reference to a QueryListener that will be called when the value of one of the filters has changed.
queryPivotListener	javax.el.MethodExpression	Only EL	A method reference to a QueryPivotListener that will be called after a pivot operation is performed on the PivotFilterBar.
rendered	boolean	Yes	Default Value: true Whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
shortDesc	String	Yes	The short description 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.
styleClass	String	Yes	A CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
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	Object	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	Default Value: true 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.