oracle.dss.dataView
Class UIDataviewAdapter

java.lang.Object
  |
  +--oracle.dss.util.PagingControlAttributesAdapter
        |
        +--oracle.dss.dataView.UIDataviewAdapter

All Implemented Interfaces:

ComponentTypeConverter, DataviewCommon, PagingControlAttributes, UIDataview

Direct Known Subclasses:

UIGraphAdapter, UIGridViewAdapter

public abstract class UIDataviewAdapter

extends PagingControlAttributesAdapter

implements UIDataview, DataviewCommon

Adapter class for the UIDataview interface. Create an instance of a concrete subclass of this proxy class so that the UI panels can be displayed before a view is constructed.

Constructor Summary

UIDataviewAdapter()
Constructor

UIDataviewAdapter(UIDataview view)
Constructor that initializes this adapter from a UIDataview.

Method Summary

void	addControllerListener(ControllerListener l) Adds a listener for user gestures that do not affect data, such as selecting or resizing a component.
void	applyToDataview(UIDataview view) Apply properties of this adapter to a UIDataview.
int	convertComponentTypeToInteger(java.lang.String type) Retrieves an integer representation of a view component, from a String.
java.lang.String	convertComponentTypeToString(int type) Retrieves a String representation of a view component, from an integer.
DataSource	getDataSource() Retrieves the data source for this view.
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 UIDataviewAdapter uses.
Model	getModel() Get the model for the common view.
ComponentHandle	getSelectedObject() Retrieves the selected component.
TokenSubstitution	getTokenSubstitution() Retrieves the handler for token substitution in this view.
abstract int	getViewType() Get the specific type of the view.
int	getZoomFactor() Retrieves the default zoom factor for this view.
void	initFromDataview(UIDataview view) Initialize the properties of this adapter from a UIDataview.
void	removeControllerListener(ControllerListener l) Removes a listener for user gestures that do not affect data.
boolean	selectObject(ComponentHandle handle) Sets the selected component.
void	setDataSource(DataSource ds) Specifies the data source for this view.
void	setLocale(java.util.Locale loc) Sets the Locale that this UIDataviewAdapter uses.
void	setTokenSubstitution(TokenSubstitution token) Specifies a handler for token substitution in this view.

Methods inherited from class oracle.dss.util.PagingControlAttributesAdapter

applyToPagingControlAttributes, initFromPagingControlAttributes, isPagingControlVisible, setPagingControlVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.util.PagingControlAttributes

isPagingControlVisible, setPagingControlVisible

Methods inherited from interface oracle.dss.dataView.DataviewCommon

getErrorHandler, getHTMLPagingControlWidth, isHTMLPagingControlAutosubmit, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth

Constructor Detail

UIDataviewAdapter

public UIDataviewAdapter()

Constructor

UIDataviewAdapter

public UIDataviewAdapter(UIDataview view)

Constructor that initializes this adapter from a UIDataview.

Parameters:

view - the UIDataview used to initialize this adapter

Method Detail

initFromDataview

public void initFromDataview(UIDataview view)

Initialize the properties of this adapter from a UIDataview. The view's Locale and SelectedObject will be set on this adapter. This method calls the superclass initFromPagingControlAttributes method.

Parameters:

view - the UIDataview used to initialize this adapter

applyToDataview

public void applyToDataview(UIDataview view)

Apply properties of this adapter to a UIDataview. This method calls the superclass applyToPagingControlAttributes method.

Parameters:

view - the view to which properties of this adapter will be applied

getLocale

public java.util.Locale getLocale()

Retrieves the Locale that this UIDataviewAdapter uses.

Specified by:

getLocale in interface UIDataview

Returns:

loc The Locale for this UIDataviewAdapter.

setLocale

public void setLocale(java.util.Locale loc)

Sets the Locale that this UIDataviewAdapter uses.

Parameters:

loc - The Locale for this UIDataviewAdapter.

getSelectedObject

public ComponentHandle getSelectedObject()

Retrieves the selected component.

Specified by:

getSelectedObject in interface UIDataview

Returns:

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

getDataviewTitle

public DataviewTitles getDataviewTitle()

Retrieves the Title component for this dataview.

Specified by:

getDataviewTitle in interface UIDataview

Returns:

The Title component for this dataview.

getDataviewSubtitle

public DataviewTitles getDataviewSubtitle()

Retrieves the Subtitle component for this dataview.

Specified by:

getDataviewSubtitle in interface UIDataview

Returns:

The Subtitle component for this dataview.

getDataviewFootnote

public DataviewTitles getDataviewFootnote()

Retrieves the Footnote component for this dataview.

Specified by:

getDataviewFootnote in interface UIDataview

Returns:

The Footnote component for this dataview.

selectObject

public boolean selectObject(ComponentHandle handle)

Sets the selected component.

Parameters:

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

Returns:

true if the component is successfully selected, false if not

addControllerListener

public void addControllerListener(ControllerListener l)

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

Specified by:

addControllerListener in interface UIDataview

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.

Specified by:

removeControllerListener in interface UIDataview

Parameters:

l - The listener to remove.

getViewType

public abstract int getViewType()

Get the specific type of the view. Constants representing valid returned values are defined in Dataview and begin with VIEW_TYPE_. Subclasses of this class implement this method to return the specific type of view.

Specified by:

getViewType in interface UIDataview

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.

Specified by:

setTokenSubstitution in interface UIDataview

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.

Specified by:

getTokenSubstitution in interface UIDataview

Returns:

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

getZoomFactor

public int getZoomFactor()

Retrieves the default zoom factor for this view. This number serves as the reference point for calls to the scaleFont method.

Returns:

The default zoom factor for this view.

getModel

public Model getModel()

Get the model for the common view.

Specified by:

getModel in interface DataviewCommon

Returns:

the common view's model

convertComponentTypeToInteger

public int convertComponentTypeToInteger(java.lang.String type)

Retrieves an integer representation of a view component, from a String.

Specified by:

convertComponentTypeToInteger in interface ComponentTypeConverter

Parameters:

An - identifier for a view component.

convertComponentTypeToString

public java.lang.String convertComponentTypeToString(int type)

Retrieves a String representation of a view component, from an integer.

Specified by:

convertComponentTypeToString in interface ComponentTypeConverter

Parameters:

type - An identifier for a view component.

setDataSource

public void setDataSource(DataSource ds)

Specifies the data source for this view. In the Model-View-Controller architecture, the data source is the model. It feeds data to the view for display. The Model class in a visualization bean represents the DataSource to the view, but the DataSource is the real source of the data.

Specified by:

setDataSource in interface DataviewCommon

Parameters:

ds - The data source for this view.

getDataSource

public DataSource getDataSource()

Retrieves the data source for this view.

Specified by:

getDataSource in interface DataviewCommon

Returns:

The DataSource for this view. If no model or data source has been set for this view, this method returns null.