oracle.dss.dataView

Interface UIDataview

All Superinterfaces:

PagingControlAttributes, UIView

All Known Implementing Classes:

Dataview, Gauge, Graph, UIDataviewAdapter

public interface UIDataview
extends PagingControlAttributes, UIView

Interface for a Dataview. The default user interface for a view calls 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

Methods

Modifier and Type	Method and Description
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.
TokenSubstitution	getTokenSubstitution() Retrieves the handler for token substitution in this view.
void	setTokenSubstitution(TokenSubstitution token) Specifies a handler for token substitution in this view.

Methods inherited from interface oracle.dss.util.PagingControlAttributes

isPagingControlVisible, setPagingControlVisible

Methods inherited from interface oracle.dss.dataView.UIView

addControllerListener, getLocale, getModel, getSelectedObject, getViewType, isCustomColorsEnabled, removeControllerListener, setCustomColorsEnabled

Method Detail

setTokenSubstitution

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

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

DataviewTitles getDataviewTitle()

Retrieves the Title component for this dataview.

Returns:

The Title component for this dataview.

getDataviewSubtitle

DataviewTitles getDataviewSubtitle()

Retrieves the Subtitle component for this dataview.

Returns:

The Subtitle component for this dataview.

getDataviewFootnote

DataviewTitles getDataviewFootnote()

Retrieves the Footnote component for this dataview.

Returns:

The Footnote component for this dataview.