oracle.dss.thin.beans.tools
Interface ViewTool

All Superinterfaces:

ThinBean, ThinBeanUI

All Known Implementing Classes:

BaseViewTool

public interface ViewTool

extends ThinBeanUI

Interface for all the ViewTools.

See Also:

ThinDataviewCommon, ViewToolbar, BaseViewTool, ViewToolListener, ViewToolEvent

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

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Method Summary

void	addViewToolListener(ViewToolListener l) Registers a listener for the ViewToolEvents
oracle.cabo.ui.UINode	getContentUINode() Retrieves the UINode used to render this ViewTool in the ViewToolbar.
java.lang.String	getDestination() Returns the destination URL for the tool.
java.lang.String	getDisplayName() Retrieves the name used to display this tool on the ViewToolbar
java.lang.String	getToolbarName() Returns the thin bean name of the toolbar this tools belongs to When the tool belongs to a toolbar, all the events generated by this tool will be handled by the toolbar.
ThinDataviewCommon	getView() Retrieves the view modified by this ViewTool.
boolean	isEnabled() Indicates whether the tool's link appears on the toolbar.
boolean	isVisible() Indicates whether the tool's controls are visible in the ViewToolbar
void	removeViewToolListener(ViewToolListener l) Unregisters a listener for the ViewToolEvents
void	setDestination(java.lang.String destination) Specifies the destination URL for the tool.
void	setDisplayName(java.lang.String name) Sets the name used to display this tool on the ViewToolbar
void	setEnabled(boolean enabled) Specifies whether the tool's link appears on the toolbar.
void	setToolbarName(java.lang.String toolbarName) Specifies the thin bean name of the toolbar this tools belongs to When the tool belongs to a toolbar, all the events generated by this tool will be handled by the toolbar.
void	setView(ThinDataviewCommon view) Specifies the view modified by this ViewTool.
void	setVisible(boolean visible) Specifies whether the tool's controls are visible in the ViewToolbar

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

getEventTarget, getLocale, handleEvent, setEventTarget, setLocale

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

getState, getThinBeanName, setBaseState, setState, setThinBeanName

Method Detail

setView

public void setView(ThinDataviewCommon view)

Specifies the view modified by this ViewTool.

Parameters:

a - view implementing interface ThinDataviewCommon

getView

public ThinDataviewCommon getView()

Retrieves the view modified by this ViewTool.

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:

ViewToolEvent

getContentUINode

public oracle.cabo.ui.UINode getContentUINode()

Retrieves the UINode used to render this ViewTool in the ViewToolbar.

Returns:

UINode used to render this view tool

See Also:

ViewToolbar

getDisplayName

public java.lang.String getDisplayName()

Retrieves the name used to display this tool on the ViewToolbar

Returns:

tool display name

See Also:

ViewToolbar

setDisplayName

public void setDisplayName(java.lang.String name)

Sets the name used to display this tool on the ViewToolbar

Parameters:

display - name

See Also:

ViewToolbar

isVisible

public boolean isVisible()

Indicates whether the tool's controls are visible in the ViewToolbar

Returns:

true if visible

See Also:

ViewToolbar

setVisible

public void setVisible(boolean visible)

Specifies whether the tool's controls are visible in the ViewToolbar

Parameters:

visible - true if the controls should be visible false otherwise

See Also:

ViewToolbar

isEnabled

public boolean isEnabled()

Indicates whether the tool's link appears on the toolbar. For example, when the current View's DataSource is not an instance of an OLAP Query, the SortTool and FavoriteTool become disabled.

Returns:

true if enabled, false otherwise

See Also:

ViewToolbar

setEnabled

public void setEnabled(boolean enabled)

Specifies whether the tool's link appears on the toolbar. For example, when the current View's DataSource is not an instance of an OLAP Query, the SortTool and FavoriteTool become disabled.

Parameters:

true - if enabled, false otherwise

See Also:

ViewToolbar

getDestination

public java.lang.String getDestination()

Returns the destination URL for the tool. When the destination URL is set on the ViewTool, the ViewToolbar renders a link with the tool display name and the given destination. When the destination is not set, the ViewToolbar renders a link which generates BIConstants.SHOW_TOOL_EVENT to display the tool's controls in the same page.

Returns:

destination URL

See Also:

ViewToolbar

setDestination

public void setDestination(java.lang.String destination)

Specifies the destination URL for the tool. the destination URL for the tool. When the destination URL is set on the ViewTool, the ViewToolbar renders a link with the tool display name and the given destination. When the destination is not set, the ViewToolbar renders a link which generates BIConstants.SHOW_TOOL_EVENT to display the tool's controls in the same page.

Parameters:

destination - URL

See Also:

ViewToolbar

getToolbarName

public java.lang.String getToolbarName()

Returns the thin bean name of the toolbar this tools belongs to When the tool belongs to a toolbar, all the events generated by this tool will be handled by the toolbar.

Returns:

the thin bean name of the toolbar

See Also:

ViewToolbar

setToolbarName

public void setToolbarName(java.lang.String toolbarName)

Specifies the thin bean name of the toolbar this tools belongs to When the tool belongs to a toolbar, all the events generated by this tool will be handled by the toolbar.

Parameters:

toolbarName - the thin bean name of the toolbar

See Also:

ViewToolbar