oracle.dss.thin.beans.tools
Class RotateTool

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.tools.BaseViewTool
              |
              +--oracle.dss.thin.beans.tools.RotateTool

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI, ViewTool

public class RotateTool

extends BaseViewTool

RotateTool is used to change the layout of a View. RotateTool can be used standalone or with oracle.dss.thin.beans.toolbar.ViewToolbar.

The RotateTool generates the following events:

• BIConstants.ROTATE_EVENT -- generated by pressing the "Go" button. This event is handled by the ThinDataviewCommon set on the RotateTool.

For more information about using the RotateTool, see the "Rotate Tool" topic in the BI Beans Help system.

See Also:

ThinDataviewCommon, ViewToolbar, ViewTool

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

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

RotateTool()
Constructor.

RotateTool(ThinDataviewCommon dataview)
Constructor.

Method Summary

oracle.cabo.ui.UINode	getContentUINode() Retrieves the UINode used to render this ViewTool
java.lang.String	getDisplayName() Retrieves the name used to display this tool on the ViewToolbar
int	handleEvent(QueryParameterProvider provider) An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request.
boolean	isViewRelational() Determines whether the view on which this tool operates is relational
void	setView(ThinDataviewCommon view) Specifies the view modified by this ViewTool.

Methods inherited from class oracle.dss.thin.beans.tools.BaseViewTool

addViewToolListener, getDestination, getToolbarName, getView, isEnabled, isVisible, removeViewToolListener, setDestination, setDisplayName, setEnabled, setToolbarName, setVisible

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

addErrorHandler, checkpointState, generateOnClickSubmit, getCheckpointState, getEventTarget, getLocale, getState, getThinBeanName, removeErrorHandler, setBaseState, setCheckpointState, setEventTarget, setLocale, setState, setThinBeanName

Methods inherited from class java.lang.Object

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

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

getEventTarget, getLocale, setEventTarget, setLocale

Methods inherited from interface oracle.dss.thin.beans.ThinBean

getState, getThinBeanName, setBaseState, setState, setThinBeanName

Constructor Detail

RotateTool

public RotateTool()

Constructor.

RotateTool

public RotateTool(ThinDataviewCommon dataview)

Constructor.

Method Detail

setView

public void setView(ThinDataviewCommon view)

Specifies the view modified by this ViewTool.

Overrides:

setView in class BaseViewTool

Parameters:

a - view implementing interface ThinDataviewCommon

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

isViewRelational

public boolean isViewRelational()

Determines whether the view on which this tool operates is relational

Returns:

boolean indicating whether view is relational

getContentUINode

public oracle.cabo.ui.UINode getContentUINode()

Retrieves the UINode used to render this ViewTool

Returns:

UINode used to render this view tool

getDisplayName

public java.lang.String getDisplayName()

Retrieves the name used to display this tool on the ViewToolbar

Overrides:

getDisplayName in class BaseViewTool

Returns:

tool display name

See Also:

ViewToolbar