oracle.dss.dataView
Interface UIDataview

All Superinterfaces:

PagingControlAttributes

All Known Subinterfaces:

UICrosstab, UIGraph, UIGridView, UITable

All Known Implementing Classes:

Dataview, UIDataviewAdapter

public interface UIDataview

extends PagingControlAttributes

Interface for a Dataview. The user interface panels for a view call the methods in this interface as it interacts with the view. This interface is implemented internally and is used by the BI Beans user interface panels. Application developers should not implement this interface.

Method Summary

void	addControllerListener(ControllerListener l) Adds a listener for user gestures that do not affect data, such as selecting or resizing a component.
DataviewTitles	getDataviewFootnote() Retrieves the Footnote component for this dataview.
DataviewTitles	getDataviewSubtitle() Retrieves the Subtitle component for this dataview.
DataviewTitles	getDataviewTitle() Retrieves the Title component for this dataview.
java.util.Locale	getLocale() Retrieves the Locale that this UIDataview uses.
ComponentHandle	getSelectedObject() Retrieves the selected component.
TokenSubstitution	getTokenSubstitution() Retrieves the handler for token substitution in this view.
int	getViewType() Get the specific type of the view.
void	removeControllerListener(ControllerListener l) Removes a listener for user gestures that do not affect data.
void	setTokenSubstitution(TokenSubstitution token) Specifies a handler for token substitution in this view.

Methods inherited from interface oracle.dss.util.PagingControlAttributes

isPagingControlVisible, setPagingControlVisible

Method Detail

getLocale

public java.util.Locale getLocale()

Retrieves the Locale that this UIDataview uses.

Returns:

loc The Locale for this UIDataview.

getSelectedObject

public ComponentHandle getSelectedObject()

Retrieves the selected component.

Returns:

A handle for the selected component. The return value should actually be a concrete subclass of ComponentHandle.

addControllerListener

public void addControllerListener(ControllerListener l)

Adds a listener for user gestures that do not affect data, such as selecting or resizing a component.

Parameters:

l - The listener to add.

See Also:

ControllerListener.componentSelected(oracle.dss.dataView.ControllerEvent), ControllerListenerAdapter

removeControllerListener

public void removeControllerListener(ControllerListener l)

Removes a listener for user gestures that do not affect data.

Parameters:

l - The listener to remove.

getViewType

public int getViewType()

Get the specific type of the view. Constants representing valid returned values are defined in Dataview and begin with VIEW_TYPE_.

Returns:

an integer constant representing the specific type of view

See Also:

Dataview.VIEW_TYPE_CROSSTAB, Dataview.VIEW_TYPE_GRAPH, Dataview.VIEW_TYPE_TABLE

setTokenSubstitution

public void setTokenSubstitution(TokenSubstitution token)

Specifies a handler for token substitution in this view. Token substitution handlers make it possible for users to insert tokens (such as a token for the current dimension member) in the title, subtitle, and footnote of this view. Most application developers will use the default TokenSubstitution. You need to call this method only if you provide your own handler for allowing users to insert tokens.

Parameters:

token - The token substitution handler for this view.

getTokenSubstitution

public TokenSubstitution getTokenSubstitution()

Retrieves the handler for token substitution in this view. Token substitution handlers make it possible for users to insert tokens (such as a token for the current dimension member) in the title, subtitle, and footnote of this view. Most application developers will use the default TokenSubstitution.

Returns:

The token substitution handler for this view. By default, this is a TokenSubstitutionAdapter.

getDataviewTitle

public DataviewTitles getDataviewTitle()

Retrieves the Title component for this dataview.

Returns:

The Title component for this dataview.

getDataviewSubtitle

public DataviewTitles getDataviewSubtitle()

Retrieves the Subtitle component for this dataview.

Returns:

The Subtitle component for this dataview.

getDataviewFootnote

public DataviewTitles getDataviewFootnote()

Retrieves the Footnote component for this dataview.

Returns:

The Footnote component for this dataview.