The View Toolbar is a BI Beans thin bean, for use in an HTML-client application. By default, it displays icons for the following tools across the top of a thin Dataview
:
View Type tool -- Changes the type of the thin Dataview
; works against any data source
Rotate tool -- Changes the layout of the data in the thin Dataview
; works against any data source
Sort tool -- Sorts the dimension members in an edge of the thin Dataview
; works only against OLAP data.
Favorite tool -- Selects a set of dimension members to display in a thin Dataview
; works only against OLAP data.
When a user clicks one of the icons, then the View Toolbar displays that tool.
The ThinBeanUI
implementation of the View Toolbar is the oracle.dss.thin.beans.toolbar.ViewToolbar
class. The UINode
for the View toolbar is oracle.dss.thin.beans.toolbar.ViewToolbarBean
.
To render the View Toolbar, your servlet must associate
the ViewToolbar
object with the ViewToolbarBean
object.
The JSP tag for this bean is the Toolbar
tag. In the UIX Language, the definition element is the viewToolbarDef element,
and the UINode
is the viewToolbar element.
You should store the ViewToolbar
in the HTTP session.
The View Toolbar keeps track of the currently selected tool.
To use the View Toolbar, you must instantiate an instance of the ViewToolbar
class and then call the setView
method on the instance to set the view upon which the tools in the toolbar should operate.
When you instantiate a ViewToolbar
, the ViewToolbar
instantiates each of the view tools and adds the tools to itself. When you set the view on the ViewToolbar
, then the ViewToolbar
sets the view on each of its tools.
By default, all of the view tools are added to the toolbar, if you have OLAP data. If you do not have OLAP data, the Sort tool and the Favorite tool are not added to the View Toolbar. You can remove tools by calling the ViewToolbar.removeViewTool
method.
The View Type Tool generates the VIEW_TYPE_CHANGED_EVENT
, for which you must register a listener. When users change the type of view they want to see, the listener must instantiate a new thin presentation bean. If you do not remove the ViewTypeTool
from the ViewToolbar
, then you must register a ViewToolListener
with the ViewToolbar
, to handle the VIEW_TYPE_CHANGED_EVENT
. For more information, see the View Type Tool.
The View Toolbar generates the following thin-bean events, which are defined in the oracle.dss.thin.beans.BIConstants
interface:
SHOW_TOOL_EVENT
-- The ViewToolbar
also handles this event.
HIDE_TOOLS_EVENT
-- The ViewToolbar
also handles this event. It has no parameters.
The ViewToolbar
handles the following events:
SHOW_TOOL_EVENT
-- In response to this event, the ViewToolbar
makes the selected tool visible.
HIDE_TOOLS_EVENT
-- In response to this event, the ViewToolbar
hides all of its view tools.