Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.thin.beans.tools
Class ViewTypeTool

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.tools.BaseViewTool
              |
              +--oracle.dss.thin.beans.tools.ViewTypeTool
All Implemented Interfaces:
CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI, ViewTool

public class ViewTypeTool
extends BaseViewTool

ViewTypeTool is used to change the the View type. ViewTypeTool can be used standalone or with oracle.dss.thin.beans.toolbar.ViewToolbar.

The ViewTypeTool generates the following events:

The ViewTypeTool handles the following events:

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

See Also:
ViewTypeChangedEvent, ViewToolListener, ViewToolbar

Field Summary
static java.lang.String CROSSTAB
           
static java.lang.String GRAPH
           
static java.lang.String TABLE
           

 

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI
EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

 

Constructor Summary
ViewTypeTool()
          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
 GraphTypeConverter getGraphTypeConverter()
          Retrieves the graph type converter used to display all the available Graph types and subtypes
 int handleEvent(QueryParameterProvider provider)
          An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request.
 void setGraphTypeConverter(GraphTypeConverter graphTypeConverter)
          Specifies the graph type converter used to display all the available Graph types and subtypes
 void setLocale(java.util.Locale loc)
          Specifies the Locale for this ViewToolbar.
 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, 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

 

Methods inherited from interface oracle.dss.thin.beans.ThinBean
getState, getThinBeanName, setBaseState, setState, setThinBeanName

 

Field Detail

CROSSTAB

public static final java.lang.String CROSSTAB

TABLE

public static final java.lang.String TABLE

GRAPH

public static final java.lang.String GRAPH
Constructor Detail

ViewTypeTool

public ViewTypeTool()
Constructor.
Method Detail

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

setGraphTypeConverter

public void setGraphTypeConverter(GraphTypeConverter graphTypeConverter)
Specifies the graph type converter used to display all the available Graph types and subtypes
Parameters:
graph - type converter
See Also:
GraphTypeConverter

getGraphTypeConverter

public GraphTypeConverter getGraphTypeConverter()
Retrieves the graph type converter used to display all the available Graph types and subtypes
Returns:
graph type converter
See Also:
GraphTypeConverter

setView

public void setView(ThinDataviewCommon view)
Specifies the view modified by this ViewTool.
Overrides:
setView in class BaseViewTool
Parameters:
a - view implementing interface ThinDataviewCommon

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

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.

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.