oracle.dss.thin.beans.toolbar
Class ViewToolbar

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.toolbar.ViewToolbar

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

public class ViewToolbar

extends BaseThinBeanUI

The ViewToolbar is a container for the ViewTools.

The ViewToolbar generates the following events:

• BIConstants.SHOW_TOOL_EVENT -- generated when a tool is selected on the toolbar
• BIConstants.HIDE_TOOLS_EVENT -- generated when the tools are hidden

The ViewToolbar handles the following events:

• BIConstants.SHOW_TOOL_EVENT -- generated when a tool is selected on the toolbar
• BIConstants.HIDE_TOOLS_EVENT -- generated when the tools are hidden
• Events generated by the registered tools.
  For all the events coming from the registered tools, ViewToolbar uses BIConstants.ORIGIN parameter to find the thin bean name of the ViewTool, and if a ViewToool with that name is registered with the toolbar, the event is passed to it.

When the ViewToolbar creates its tools automatically the tool names are set to [toolbar name] + [default tool name] where the default tool names are:

• ViewTypeTool: "vtt"
• RotateTool: "rt"
• SortTool: "st"
• FavoriteTool: "ft"

For more information about using the ViewToolbar, see the "View Toolbar" topic in the BI Beans Help system.

See Also:

ViewTool, ViewToolListener, ViewToolEvent, ViewTypeTool, RotateTool, FavoriteTool, SortTool

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

ViewToolbar()
Constructor.

Method Summary

void	addViewTool(ViewTool viewTool) Registers a ViewTool with the toolbar
void	addViewToolListener(ViewToolListener l) Registers a listener for the ViewToolEvents
void	checkpointState() Tells the ThinBean to start tracking state changes.
java.lang.String	getCheckpointState() Used to retrieve the state differences from the last time that state was checkpointed.
java.lang.String	getState() Returns a String that represents the changes in the ViewToolbar, since the ViewToolbar was created or since setBaseState() was called.
ThinDataviewCommon	getView() Retrieves the view modified by this ViewToolbar.
java.util.Vector	getViewTools() Retrieves all the ViewTool thin beans
java.lang.String	getVisibleTool() Retrieves the thin bean name of the currently visible tool
int	handleEvent(QueryParameterProvider provider) An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request.
void	removeViewTool(ViewTool viewTool) Unregisters a ViewTool from the toolbar
void	removeViewToolListener(ViewToolListener l) Unregisters a listener for the ViewToolEvents
void	setBaseState() Establishes a base state for the ViewToolbar from which state changes that go onto the state string are tracked.
void	setCheckpointState(java.lang.String state) Used to set state differences from the last time that state was checkpointed.
void	setLocale(java.util.Locale loc) Specifies the Locale for this ViewToolbar.
void	setState(java.lang.String state) Sets a state string that represents the changes on the ViewToolbar, since the ViewToolbar was created or since setBaseState() was called.
void	setThinBeanName(java.lang.String thinBeanName) The ThinBeanName is used to uniquely identify a ThinBeanUI.
void	setView(ThinDataviewCommon view) Specifies the view modified by this ViewToolbar.
void	setVisibleTool(java.lang.String toolName) Sets the tool identified by the parameter to be visible

Methods inherited from class oracle.dss.thin.beans.BaseThinBeanUI

addErrorHandler, generateOnClickSubmit, getEventTarget, getLocale, getThinBeanName, removeErrorHandler, setEventTarget

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ViewToolbar

public ViewToolbar()

Constructor.

Method Detail

setBaseState

public void setBaseState()

Establishes a base state for the ViewToolbar from which state changes that go onto the state string are tracked. This call will effectively clear the thin bean's current state string.

Overrides:

setBaseState in class BaseThinBeanUI

setState

public void setState(java.lang.String state)

Sets a state string that represents the changes on the ViewToolbar, since the ViewToolbar was created or since setBaseState() was called. This string placed onto the URLs/Forms that an application generates, so that the application can re-establish the thin bean's state from a request's URL. This placing of an application's state onto the URL supports the ability for the application to support re-establishing application state from a bookmark.

Overrides:

setState in class BaseThinBeanUI

Parameters:

a - ViewToolbar state

getState

public java.lang.String getState()

Returns a String that represents the changes in the ViewToolbar, since the ViewToolbar was created or since setBaseState() was called. This string placed onto the URLs/Forms that an application generates, so that the application can re-establish the thin bean's state from a request's URL. This placing of an application's state onto the URL supports the ability for the application to support re-establishing application state from a bookmark.

Overrides:

getState in class BaseThinBeanUI

Returns:

the ViewToolbar's state

getCheckpointState

public java.lang.String getCheckpointState()

Used to retrieve the state differences from the last time that state was checkpointed.

Overrides:

getCheckpointState in class BaseThinBeanUI

Returns:

the state differences from the last checkpoint

setCheckpointState

public void setCheckpointState(java.lang.String state)
                        throws ThinException

Used to set state differences from the last time that state was checkpointed.

Overrides:

setCheckpointState in class BaseThinBeanUI

Parameters:

state - the state differences from the last checkpoint

Throws:

ThinException - if the state could not be set

checkpointState

public void checkpointState()

Tells the ThinBean to start tracking state changes.

Overrides:

checkpointState in class BaseThinBeanUI

Following copied from interface: oracle.dss.thin.beans.CheckpointState

See Also:

ThinBean.getState(), BIStateManager

setView

public void setView(ThinDataviewCommon view)

Specifies the view modified by this ViewToolbar.

Parameters:

a - view implementing interface ThinDataviewCommon

getView

public ThinDataviewCommon getView()

Retrieves the view modified by this ViewToolbar.

Returns:

a view implementing interface ThinDataviewCommon

addViewToolListener

public void addViewToolListener(ViewToolListener l)

Registers a listener for the ViewToolEvents

Parameters:

l - The listener to add.

See Also:

ViewToolEvent

removeViewToolListener

public void removeViewToolListener(ViewToolListener l)

Unregisters a listener for the ViewToolEvents

Parameters:

l - The listener to remove.

See Also:

ViewTypeChangedEvent

setThinBeanName

public void setThinBeanName(java.lang.String thinBeanName)

The ThinBeanName is used to uniquely identify a ThinBeanUI. An application may have multiple thin beans in an application at the same time. Events that an ThinBeanUI generates will also include a "source" event parameter ( really just a query parameter on a URL ), which has a value that is the ThinBeanName.

Overrides:

setThinBeanName in class BaseThinBeanUI

Parameters:

thinBeanName - the ThinBeanUI's name

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request. To determine the correct ThinBean to call handleEvent() on, the application should check the "source" query parameter, which will be the ThinBeanName of the ThinBean that rendered the URL/Form in HTML and which also needs to handle the event. The application can also choose to call handleEvent on all of its ThinBeanUI components and check the return value of handleEvent() to determine which component has handled the event. Each ThinBeanUI component needs to check the source parameter to make sure that it matches their ThinBeanName. If it does not match, then the event should not be processed.

Parameters:

provider - An instance of a QueryParameterProvider that returns decoded and unescaped query parameter values from HTTPServletRequests

Returns:

EVENT_NOT_HANDLED, EVENT_HANDLED, or EVENT_RESPONSE_DONE

See Also:

ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE

setVisibleTool

public void setVisibleTool(java.lang.String toolName)

Sets the tool identified by the parameter to be visible

Parameters:

toolName - the tool's thin bean name If no tools match the name, all tools will be hidden

getVisibleTool

public java.lang.String getVisibleTool()

Retrieves the thin bean name of the currently visible tool

Returns:

the thin bean name of the visible tool returns null if no tools are visible

addViewTool

public void addViewTool(ViewTool viewTool)

Registers a ViewTool with the toolbar

Parameters:

viewTool - The view tool to add.

See Also:

ViewTool

removeViewTool

public void removeViewTool(ViewTool viewTool)

Unregisters a ViewTool from the toolbar

Parameters:

viewTool - The view tool to remove.

See Also:

ViewTool

getViewTools

public java.util.Vector getViewTools()

Retrieves all the ViewTool thin beans

Returns:

the Vector of ViewTools

See Also:

ViewTool

setLocale

public void setLocale(java.util.Locale loc)

Specifies the Locale for this ViewToolbar.

Overrides:

setLocale in class BaseThinBeanUI

Parameters:

loc - The Locale for this ViewToolbar.