oracle.dss.dataView
Interface DataviewCommon

All Superinterfaces:

ComponentTypeConverter

All Known Subinterfaces:

ImageView

All Known Implementing Classes:

CommonDataview, CommonGauge, CommonGraph, Dataview, Gauge, Graph, UIDataviewAdapter

public interface DataviewCommon
extends ComponentTypeConverter

Methods that are common to Java-client views and HTML-client views.

Method Summary

java.util.BitSet	createPropertyOverrideFlags(int maxID)
void	dataFormatChanged()
void	dataStyleChanged()
DataSource	getDataSource() Retrieves the data source for this view.
DataviewTitles	getDataviewFootnote() Retrieves the footnote for this view.
DataviewTitles	getDataviewSubtitle() Retrieves the subtitle for this view.
DataviewTitles	getDataviewTitle() Retrieves the title for this view.
ErrorHandler	getErrorHandler() Retrieves the current error handler for this view.
FontList	getFontList()
int	getHTMLPagingControlWidth() Retrieves the number of page items that are displayed before the paging control wraps.
java.lang.String	getIntlString(java.lang.String key)
java.lang.String	getIntlString(java.lang.String key, java.util.ResourceBundle rBundle)
java.lang.String	getLayerMetadataLabelType(int edge) Retrieves the type of labels that this view displays for dimension names on the specified edge.
java.util.Locale	getLocale() Retrieves the Locale for this DataviewCommon.
java.lang.String	getMemberMetadataLabelType(int edge) Retrieves the type of labels that this view displays for dimension members on the specified edge.
Model	getModel() Retrieves the model for this DataviewCommon.
TokenSubstitution	getTokenSubstitution() Retrieves the handler for token substitution in this view.
int	getViewType()
WaitData	getWaitDataForRow(int row)
int	getZoomFactor()
boolean	isDataUnformattedSupported()
boolean	isDataViewFormatSupported()
boolean	isHTMLPagingControlAutosubmit() Indicates whether paging control changes are automatically submitted.
boolean	isLayerMetadataLabelTypeSupported(java.lang.String type)
boolean	isLayerMetaShortLabelSupported()
boolean	isLayerMetaViewStyleSupported()
boolean	isMemberMetadataLabelTypeSupported(java.lang.String type)
boolean	isMetadataShortLabelSupported()
boolean	isMetadataViewStyleSupported()
boolean	isPagingControlVisible()
boolean	isPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
void	metadataStyleChanged()
void	repaint()
java.awt.Font	scaleFont(java.awt.Font f, int zoomFactor)
void	setDataSource(DataSource ds) Specifies the data source for this view.
void	setHTMLPagingControlAutosubmit(boolean autosubmit) Specifies whether paging control changes are automatically submitted.
void	setHTMLPagingControlWidth(int width) Specifies the number of page items that are displayed before the paging control wraps to a new line.
void	setPagingControlVisible(boolean v)
void	setPropertyOverrideFlags(int attrID, java.util.BitSet userFlags, java.util.BitSet styleFlags)
void	setTokenSubstitution(TokenSubstitution token) Specifies a handler for token substitution in this view.
void	setWaitDataForRow(int row, WaitData waitData)

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Method Detail

getErrorHandler

ErrorHandler getErrorHandler()

Retrieves the current error handler for this view.

Returns:

The current error handler for this view.

getFontList

FontList getFontList()

Returns:

The current font cache list.

getZoomFactor

int getZoomFactor()

Returns:

The default zoom factor for this view.

scaleFont

java.awt.Font scaleFont(java.awt.Font f,
                        int zoomFactor)

Parameters:

f - The font to scale.

zoomFactor - The percent of the default zoom factor to make the font. For example, to double the size of the font, pass 2 * (getZoomFactor()).

getIntlString

java.lang.String getIntlString(java.lang.String key)

Parameters:

key - the String that needs to be translated.

Returns:

the translated String

getIntlString

java.lang.String getIntlString(java.lang.String key,
                               java.util.ResourceBundle rBundle)

Parameters:

key - the String that needs to be translated.

rBundle - the bundle to look in

Returns:

the translated String.

getLocale

java.util.Locale getLocale()

Retrieves the Locale for this DataviewCommon.

Parameters:

loc - The Locale for this DataviewCommon.

getModel

Model getModel()

Retrieves the model for this DataviewCommon. The model represents the data that this DataviewCommon displays.

Returns:

The model for this DataviewCommon.

isMetadataViewStyleSupported

boolean isMetadataViewStyleSupported()

Returns:

true if METADATA_VIEWSTYLE is supported, else false

isLayerMetaViewStyleSupported

boolean isLayerMetaViewStyleSupported()

isLayerMetaShortLabelSupported

boolean isLayerMetaShortLabelSupported()

isMetadataShortLabelSupported

boolean isMetadataShortLabelSupported()

isDataUnformattedSupported

boolean isDataUnformattedSupported()

isDataViewFormatSupported

boolean isDataViewFormatSupported()

Returns:

true if DATA_VIEWFORMAT is supported, else false

isMemberMetadataLabelTypeSupported

boolean isMemberMetadataLabelTypeSupported(java.lang.String type)

Parameters:

type - type of member metadata label

Returns:

true if the type is supported, false if not

isLayerMetadataLabelTypeSupported

boolean isLayerMetadataLabelTypeSupported(java.lang.String type)

Parameters:

type - type of layer metadata label

Returns:

true if the type is supported, false if not

repaint

void repaint()

metadataStyleChanged

void metadataStyleChanged()

dataStyleChanged

void dataStyleChanged()

dataFormatChanged

void dataFormatChanged()

getWaitDataForRow

WaitData getWaitDataForRow(int row)

Parameters:

row - The index of the row that you want to know about.

Returns:

If the specified row is waiting for data, then this method will return a WaitData object for the row, otherwise this method will return null.

setWaitDataForRow

void setWaitDataForRow(int row,
                       WaitData waitData)

Parameters:

row - The index of the row that is waiting for data.

waitData - The WaitData object that you want to use to display a message in each cell on the row.

setHTMLPagingControlAutosubmit

void setHTMLPagingControlAutosubmit(boolean autosubmit)

Specifies whether paging control changes are automatically submitted. By default, these changes are not submitted automatically. This property is used for the thin beans only.

Parameters:

autosubmit - true to enable automatic submission, false to disable it.

isHTMLPagingControlAutosubmit

boolean isHTMLPagingControlAutosubmit()

Indicates whether paging control changes are automatically submitted. This property is used for the thin beans only.

Returns:

true if changes are automatically submitted, false if they are not.

setHTMLPagingControlWidth

void setHTMLPagingControlWidth(int width)

Specifies the number of page items that are displayed before the paging control wraps to a new line. The default value is 3. This property is used for the thin beans only.

Parameters:

width - The number of page items to display before wrapping. To display all page items on the same line, pass -1.

getHTMLPagingControlWidth

int getHTMLPagingControlWidth()

Retrieves the number of page items that are displayed before the paging control wraps. This property is used for the thin beans only.

Returns:

The number of page items to display before wrapping.

setDataSource

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 presentation bean represents the DataSource to the view, but the DataSource is the real source of the data.

Parameters:

ds - The data source for this view.

getDataSource

DataSource getDataSource()

Retrieves the data source for this view.

Returns:

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

createPropertyOverrideFlags

java.util.BitSet createPropertyOverrideFlags(int maxID)

setPropertyOverrideFlags

void setPropertyOverrideFlags(int attrID,
                              java.util.BitSet userFlags,
                              java.util.BitSet styleFlags)

isPropertyOverrideFlag

boolean isPropertyOverrideFlag(int attrID,
                               java.util.BitSet overrideFlags)

getDataviewFootnote

DataviewTitles getDataviewFootnote()

Retrieves the footnote for this view.

Returns:

The footnote for this view.

getDataviewSubtitle

DataviewTitles getDataviewSubtitle()

Retrieves the subtitle for this view.

Returns:

The subtitle for this view.

getDataviewTitle

DataviewTitles getDataviewTitle()

Retrieves the title for this view.

Returns:

The title for this view.

getLayerMetadataLabelType

java.lang.String getLayerMetadataLabelType(int edge)

Retrieves the type of labels that this view displays for dimension names on the specified edge. The default value for all edges is LAYER_METADATA_LONGLABEL. Returns null if the specified edge is invalid.

Parameters:

edge - A constant that represents the edge for which to get the metadata label type. Valid constants are listed in the See Also section, and they end with "EDGE".

Returns:

A constant that represents the type of layer metadata label to show. Valid constants are listed in the See Also section, and they begin with "LAYER_METADATA".

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, LayerMetadataMap.LAYER_METADATA_LONGLABEL, LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL, LayerMetadataMap.LAYER_METADATA_SHORTLABEL, LayerMetadataMap.LAYER_METADATA_NAME

getMemberMetadataLabelType

java.lang.String getMemberMetadataLabelType(int edge)

Retrieves the type of labels that this view displays for dimension members on the specified edge. The default value for all edges is METADATA_LONGLABEL. Returns null if the specified edge is invalid.

Parameters:

edge - A constant that represents the edge for which to get the metadata label type. Valid constants are listed in the See Also section, and they end with "EDGE".

Returns:

A constant that represents the type of metadata label to display. Valid constants are listed in the See Also section, and they begin with "METADATA".

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_VALUE

getViewType

int getViewType()

Returns:

A constant that represents the specific type of view. Valid constants are listed in the See Also section.

See Also:

DataviewConstants.VIEW_TYPE_CROSSTAB, DataviewConstants.VIEW_TYPE_GRAPH, DataviewConstants.VIEW_TYPE_TABLE

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.

setPagingControlVisible

void setPagingControlVisible(boolean v)

isPagingControlVisible

boolean isPagingControlVisible()