oracle.dss.dataView
Class Dataview

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.dataView.Dataview

All Implemented Interfaces:

javax.accessibility.Accessible, ComponentTypeConverter, DataviewCommon, ErrorHandlerCallback, java.awt.image.ImageObserver, java.awt.MenuContainer, PagingControlAttributes, Persistable, java.io.Serializable, StringXMLizable, UIDataview

Direct Known Subclasses:

Graph, GridView

public abstract class Dataview

extends javax.swing.JPanel

implements ErrorHandlerCallback, ComponentTypeConverter, Persistable, DataviewCommon, UIDataview

The base View. In the Model-View-Controller architecture, a view presents data to users. This class defines methods and fields that are common to all the views in the BI Beans.

Application developers normally work with the concrete subclasses of this class. However, application developers will call some of these methods in the concrete subclasses.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static int	DATAVIEW_FOOTNOTE The Footnote component of this Dataview.
static java.lang.String	DATAVIEW_FOOTNOTE_NAME Name of the footnote component that the view uses.
static int	DATAVIEW_SUBTITLE The Subtitle component of this Dataview.
static java.lang.String	DATAVIEW_SUBTITLE_NAME Name of the subtitle component that the view uses.
static int	DATAVIEW_TITLE The Title component of this Dataview.
static java.lang.String	DATAVIEW_TITLE_NAME Name of the title component that the view uses.
static int	DEFAULT_ZOOM_FACTOR Default zoom factor.
static int	FOOTNOTE The Footnote component of this view.
static java.lang.String	FOOTNOTE_NAME Name of the footnote component.
static int	PAGE_CONTROL A PagingControl component of this view.
static int	PAGE_HEADER The page header for this view.
static java.lang.String	PAGE_HEADER_NAME Name of the page header.
static int	PAGE_ITEM A PageItem component of this view.
static java.lang.String	PAGE_ITEM_NAME Name of the page item.
static java.lang.String	PAGING_COMPONENT_NAME Name of the paging component.
static int	PAGING_CONTROL_ABOVE_TITLES Display the paging contol above the titles in this Dataview.
static int	PAGING_CONTROL_BELOW_TITLES Display the paging control below the titles in this Dataview.
static int	RESET_EVERYTHING Reset everything, to make the Dataview as if it were newly created.
static int	RESET_NONE Reset no default property values or listeners and callbacks before applying XML.
static int	RESET_XML_PROPERTIES Reset properties to their defaults.
static int	SUBTITLE The Subtitle component of this view.
static java.lang.String	SUBTITLE_NAME Name of the subtitle component.
static int	TITLE The Title component of this view.
static java.lang.String	TITLE_NAME Name of the title component.
static int	VIEW_TYPE_CROSSTAB View type: Crosstab.
static int	VIEW_TYPE_GRAPH View type: Graph.
static int	VIEW_TYPE_TABLE View type: Table.

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Dataview()
Constructor.

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	addDataListener(DataListener l) Adds a listener for changes to data, such as drilling or pivoting data.
void	addErrorHandler(ErrorHandler eh) Specifies the error handler for this view.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Adds a property change listener for this view.
void	addViewFocusListener(ViewFocusListener l) Adds a ViewFocusListener to this view.
void	addViewKeyListener(ViewKeyListener l) Adds a ViewKeyListener to this view.
void	addViewListener(ViewListener l) Adds a ViewListener to the listener list.
void	addViewMouseListener(ViewMouseListener l) Adds a ViewMouseListener to this view.
void	addViewMouseMotionListener(ViewMouseMotionListener l) Adds a ViewMouseMotionListener to this view.
void	cleanUp() Clears the memory of the view.
Controller	getController() Retrieves the controller for this Dataview.
DataDirector	getDataDirector() Retrieves the data director for this view.
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.
java.lang.String	getDescription() Retrieves the description of this view.
int	getHTMLPagingControlWidth() Retrieves the number of page items that are displayed in the paging control before it wraps to the next line.
TokenSubstitution	getInsertCallBack() Deprecated. As of 1.6, replaced by getTokenSubstitution()
java.util.Locale	getLocale() Retrieves the Locale that this Dataview uses.
java.lang.String	getLocalName() Retrieves the local name for this view.
Model	getModel() Retrieves the model for this Dataview.
java.lang.String	getName() Retrieves the name of this view.
PagingControl	getPagingControl() Retrieves the paging control for this view.
int	getPagingControlPosition() Retrieves the location of the paging control in this Dataview.
abstract PersistableAttributes	getPersistableAttributes(PersistableAttributes attrs) Retrieves the attributes of this Dataview, for searching.
AggregateInfo[]	getPersistableComponents() Retrieves the persistable components that this Dataview aggregates.
java.util.Vector	getPhysicalComponents() Retrieves a Vector of the physical components in this view.
PopupManager	getPopupManager() Retrieves the popup manager for this view.
abstract int	getPresentationHeight() Retrieveis the height of this view, in pixels.
abstract int	getPresentationWidth() Retrieves the width of this view, in pixels.
RolloverTextManager	getRolloverTextManager() Retrieves the rollover text manager for this view.
abstract ComponentHandle	getSelectedObject() Retrieves the selected component.
abstract int	getStartColumn() Deprecated. As of 2.6.0.27, replaced by GridView.getStartColumn() or by Graph.getStartGroup() or by Graph.getStartSeries().
abstract int	getStartRow() Deprecated. As of 2.6.0.27, replaced by GridView.getStartRow() or by Graph.getStartSeries() or by Graph.getStartGroup()
TokenSubstitution	getTokenSubstitution() Retrieves the handler for token substitution in this view.
abstract int	getViewType() Retrieves the specific type of subclass of this Dataview.
java.lang.String	getXML(boolean allProperties) Retrieves the XML string for this Dataview.
java.lang.String	getXMLAsString() Retrieves the XML representation of this Dataview.
boolean	isDrillingEnabled() Indicates whether drilling is allowed in this view.
boolean	isHTMLPagingControlAutosubmit() Indicates whether automatic submssion of information is enabled for the paging control.
boolean	isPagingControlVisible() Indicates whether the paging control appears in this view.
abstract boolean	isSwapAllowed() Indicates whether swapping is allowed in this view.
boolean	isXMLValidated() Indicates whether the Dataview validates XML against its DTD.
abstract boolean	readXML(java.io.InputStream stream, int reset) Applies XML to this Dataview, from a String.
void	removeControllerListener(ControllerListener l) Removes a listener for user gestures that do not affect data.
void	removeDataListener(DataListener l) Removes a listener for user gestures that affect data.
void	removeErrorHandler() Removes a customized error handler for this view.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Removes a property change listener from this view.
void	removeViewFocusListener(ViewFocusListener l) Removes a ViewFocusListener from this view.
void	removeViewKeyListener(ViewKeyListener l) Removes a ViewKeyListener from this view.
void	removeViewListener(ViewListener l) Removes a ViewListener from the listener list.
void	removeViewMouseListener(ViewMouseListener l) Removes a ViewMouseListener from this view.
void	removeViewMouseMotionListener(ViewMouseMotionListener l) Removes a ViewMouseMotionListener from this view.
void	resetToDefault(int reset) Resets properties of this Dataview to their default values.
abstract boolean	selectObject(ComponentHandle id) Select a component.
void	setDataSource(DataSource ds) Specifies the data source for this view.
void	setDescription(java.lang.String n) Specifies a description for this view.
void	setDrillingEnabled(boolean b) Specifies whether drilling is allowed in this view.
void	setEnabled(boolean enabled) Specifies whether this Dataview is enabled.
void	setHTMLPagingControlAutosubmit(boolean autosubmit) Specifies whether the paging control automatically submits information when someone changes a page dimension member.
void	setHTMLPagingControlWidth(int width) Specifies the number of page items that are displayed in the paging control before it wraps to the next line.
void	setInsertCallBack(TokenSubstitution token) Deprecated. As of 1.6, replaced by setTokenSubstitution(TokenSubstitution token)
void	setLocale(java.util.Locale loc) Specifies the Locale for this Dataview.
void	setLocalName(java.lang.String n) Specifies a local name for this view.
void	setName(java.lang.String n) Specifies the name of this view.
void	setPagingControlPosition(int loc) Specifies the location of the paging control in this Dataview.
void	setPagingControlVisible(boolean v) Specifies whether the paging control appears in this view.
void	setPersistableAttributes(PersistableAttributes attrs) Specifies persistable attributes that can be used in searches of the repository.
void	setPopupManager(PopupManager p) Specifies a popup manager for this view.
void	setRolloverTextManager(RolloverTextManager rm) Specifies the rollover text manager for this view.
abstract void	setStartColumn(int c) Deprecated. As of 2.6.0.27, replaced by GridView.setStartColumn(int) or by Graph.setStartGroup(int) or by Graph.setStartSeries(int).
abstract void	setStartRow(int r) Deprecated. As of 2.6.0.27, replaced by GridView.setStartRow(int) or by Graph.setStartSeries(int) or by Graph.setStartGroup(int)
abstract void	setSwapAllowed(boolean swap) Specifies whether users can swap layers in this view.
void	setTokenSubstitution(TokenSubstitution token) Specifies a handler for token substitution in this view.
abstract boolean	setXML(java.lang.String xmlString, int reset) Applies XML to this Dataview, from a String.
abstract boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of this Dataview.
void	setXMLValidated(boolean validate) Specifies whether this Dataview validates XML against its DTD.
void	writeXML(java.io.OutputStream stream, boolean allProperties) Writes XML for this Dataview to an output stream.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocation, getLocationOnScreen, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Methods inherited from interface oracle.dss.util.persistence.Persistable

initialize, setPersistableComponents

Methods inherited from interface oracle.dss.dataView.DataviewCommon

getErrorHandler

Field Detail

TITLE

public static final int TITLE

The Title component of this view. Currently, this value is used only by graphs.

See Also:

Title

SUBTITLE

public static final int SUBTITLE

The Subtitle component of this view. Currently, this value is used only by graphs.

See Also:

Subtitle

FOOTNOTE

public static final int FOOTNOTE

The Footnote component of this view. Currently, this value is used only by graphs.

See Also:

Footnote

PAGE_HEADER

public static final int PAGE_HEADER

The page header for this view.

PAGE_ITEM

public static final int PAGE_ITEM

A PageItem component of this view.

PAGE_CONTROL

public static final int PAGE_CONTROL

A PagingControl component of this view.

DATAVIEW_TITLE

public static final int DATAVIEW_TITLE

The Title component of this Dataview.

See Also:

Title

DATAVIEW_SUBTITLE

public static final int DATAVIEW_SUBTITLE

The Subtitle component of this Dataview.

See Also:

Subtitle

DATAVIEW_FOOTNOTE

public static final int DATAVIEW_FOOTNOTE

The Footnote component of this Dataview.

See Also:

Footnote

DEFAULT_ZOOM_FACTOR

public static int DEFAULT_ZOOM_FACTOR

Default zoom factor.

TITLE_NAME

public static final java.lang.String TITLE_NAME

Name of the title component.

SUBTITLE_NAME

public static final java.lang.String SUBTITLE_NAME

Name of the subtitle component.

FOOTNOTE_NAME

public static final java.lang.String FOOTNOTE_NAME

Name of the footnote component.

PAGE_HEADER_NAME

public static final java.lang.String PAGE_HEADER_NAME

Name of the page header.

PAGE_ITEM_NAME

public static final java.lang.String PAGE_ITEM_NAME

Name of the page item.

PAGING_COMPONENT_NAME

public static final java.lang.String PAGING_COMPONENT_NAME

Name of the paging component.

DATAVIEW_TITLE_NAME

public static final java.lang.String DATAVIEW_TITLE_NAME

Name of the title component that the view uses.

DATAVIEW_SUBTITLE_NAME

public static final java.lang.String DATAVIEW_SUBTITLE_NAME

Name of the subtitle component that the view uses.

DATAVIEW_FOOTNOTE_NAME

public static final java.lang.String DATAVIEW_FOOTNOTE_NAME

Name of the footnote component that the view uses.

RESET_NONE

public static final int RESET_NONE

Reset no default property values or listeners and callbacks before applying XML. Not a valid constant for the resetToDefault method.

See Also:

resetToDefault(int), readXML(java.io.InputStream, int), setXML(java.lang.String, int)

RESET_XML_PROPERTIES

public static final int RESET_XML_PROPERTIES

Reset properties to their defaults. Resets properties to the defaults, but does not remove any registered listeners and callbacks.

See Also:

resetToDefault(int), readXML(java.io.InputStream, int), setXML(java.lang.String, int)

RESET_EVERYTHING

public static final int RESET_EVERYTHING

Reset everything, to make the Dataview as if it were newly created. Resets all properties to their default settings, and removes any registered listeners and callbacks. Used mostly with the resetToDefault method.

See Also:

resetToDefault(int)

VIEW_TYPE_CROSSTAB

public static final int VIEW_TYPE_CROSSTAB

View type: Crosstab.

VIEW_TYPE_GRAPH

public static final int VIEW_TYPE_GRAPH

View type: Graph.

VIEW_TYPE_TABLE

public static final int VIEW_TYPE_TABLE

View type: Table.

PAGING_CONTROL_ABOVE_TITLES

public static final int PAGING_CONTROL_ABOVE_TITLES

Display the paging contol above the titles in this Dataview.

PAGING_CONTROL_BELOW_TITLES

public static final int PAGING_CONTROL_BELOW_TITLES

Display the paging control below the titles in this Dataview.

Constructor Detail

Dataview

public Dataview()

Constructor. Application developers should call the constructors of the concrete subclasses of this class. Those constructors call this constructor.

New subclasses of this Dataview should also set a controller and a model in their constructors.

Method Detail

setPagingControlPosition

public void setPagingControlPosition(int loc)

Specifies the location of the paging control in this Dataview. If loc is not valid, then this method positions the paging control above the titles, as if PAGING_CONTROL_ABOVE_TITLES had been specified as the location.

Parameters:

loc - A constant that indicates the location for the paging control. Constants begin with PAGING_CONTROL.

getPagingControlPosition

public int getPagingControlPosition()

Retrieves the location of the paging control in this Dataview.

Returns:

A constant that indicates the location of the paging control. Constants begin with PAGING_CONTROL.

setInsertCallBack

public void setInsertCallBack(TokenSubstitution token)

Deprecated. As of 1.6, replaced by setTokenSubstitution(TokenSubstitution token)

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

Parameters:

varsub - The token substitution handler for this view.

getInsertCallBack

public TokenSubstitution getInsertCallBack()

Deprecated. As of 1.6, replaced by getTokenSubstitution()

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

Returns:

The token substitution handler for this view.

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.

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.

getDataviewTitle

public DataviewTitles getDataviewTitle()

Retrieves the title for this view.

Specified by:

getDataviewTitle in interface UIDataview

Returns:

The title for this view.

getDataviewSubtitle

public DataviewTitles getDataviewSubtitle()

Retrieves the subtitle for this view.

Specified by:

getDataviewSubtitle in interface UIDataview

Returns:

The subtitle for this view.

getDataviewFootnote

public DataviewTitles getDataviewFootnote()

Retrieves the footnote for this view.

Specified by:

getDataviewFootnote in interface UIDataview

Returns:

The footnote for this view.

getDataDirector

public DataDirector getDataDirector()

Retrieves the data director for this view. The data director has been initialized.

Returns:

The data director for this view.

addControllerListener

public void addControllerListener(ControllerListener l)

Adds a listener for user gestures that do not affect data, such as selecting or resizing a component. Application developers call this method when they want to respond to a user gesture. For example, if you want to respond when a user selects a component, you would implement a ControllerListener and put the code to respond to the selection in the componentSelected method. You can simply extend the ControllerListenerAdapter, so that you do not have to implement all of the methods in the interface.

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.

addDataListener

public void addDataListener(DataListener l)

Adds a listener for changes to data, such as drilling or pivoting data. Application developers call this method to add listeners for data changes.

For example, if you want to intercept drill requests, implement a DataListener. In the viewDrillRequesting method, put the code for responding to the drill request. You can simply extend the DataListenerAdapter class, so that you do not have to implement the other methods in the interface.

Parameters:

l - The listener to add.

See Also:

DataListener.viewDrillRequesting(oracle.dss.dataView.DrillEvent), DataListenerAdapter

removeDataListener

public void removeDataListener(DataListener l)

Removes a listener for user gestures that affect data.

Parameters:

l - The listener to remove.

addErrorHandler

public void addErrorHandler(ErrorHandler eh)

Specifies the error handler for this view. This view can have one and only one error handler. The error handler is called when the view traps an error from another source, such as a DataSource, and when an internal error condition or exception occurs.

The default error handler prints messages to the console.

Use this method to install your own error handler. This method then sets the error handler on the Model.

Specified by:

addErrorHandler in interface ErrorHandlerCallback

Parameters:

eh - The error handler to use.

removeErrorHandler

public void removeErrorHandler()

Removes a customized error handler for this view. This method replaces the current error handler with a default error handler. This method in turn sets the new default error handler on the Model. The default error handler prints information to the console.

Specified by:

removeErrorHandler in interface ErrorHandlerCallback

addViewMouseListener

public void addViewMouseListener(ViewMouseListener l)

Adds a ViewMouseListener to this view.

Parameters:

l - The listener to add.

removeViewMouseListener

public void removeViewMouseListener(ViewMouseListener l)

Removes a ViewMouseListener from this view.

Parameters:

l - The listener to remove.

addViewMouseMotionListener

public void addViewMouseMotionListener(ViewMouseMotionListener l)

Adds a ViewMouseMotionListener to this view.

Parameters:

l - The listener to remove.

removeViewMouseMotionListener

public void removeViewMouseMotionListener(ViewMouseMotionListener l)

Removes a ViewMouseMotionListener from this view.

Parameters:

l - The listener to remove.

addViewKeyListener

public void addViewKeyListener(ViewKeyListener l)

Adds a ViewKeyListener to this view.

Parameters:

l - The listener to add.

removeViewKeyListener

public void removeViewKeyListener(ViewKeyListener l)

Removes a ViewKeyListener from this view.

Parameters:

l - The listener to remove.

addViewFocusListener

public void addViewFocusListener(ViewFocusListener l)

Adds a ViewFocusListener to this view.

Parameters:

l - The listener to add.

removeViewFocusListener

public void removeViewFocusListener(ViewFocusListener l)

Removes a ViewFocusListener from this view.

Parameters:

l - The listener to remove.

addViewListener

public void addViewListener(ViewListener l)

Adds a ViewListener to the listener list.

Parameters:

l - The listener to add.

removeViewListener

public void removeViewListener(ViewListener l)

Removes a ViewListener from the listener list.

Parameters:

l - The listener to remove.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Adds a property change listener for this view.

Overrides:

addPropertyChangeListener in class javax.swing.JComponent

Parameters:

l - The listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Removes a property change listener from this view.

Overrides:

removePropertyChangeListener in class javax.swing.JComponent

Parameters:

l - The listener to remove.

setXMLValidated

public void setXMLValidated(boolean validate)

Specifies whether this Dataview validates XML against its DTD. By default, the table does not validate the XML. If there is a parsing error in the XML, then the Dataview. ignores the badly formed XML. If you want readXML and setXML to throw a BIParseException if they encounter XML that cannot be parsed, then pass true to this method.

Parameters:

validate - true to have XML validated, false to have the Dataview ignore invalid XML.

See Also:

setXML(java.lang.String, int)

isXMLValidated

public boolean isXMLValidated()

Indicates whether the Dataview validates XML against its DTD.

Returns:

true if the Dataview validates XML, false if the Dataview applies XML without validation.

selectObject

public abstract boolean selectObject(ComponentHandle id)

Select a component.

Parameters:

id - A ComponentHandle that represents the component to select.

Returns:

true if the component is successfully selected, false if not.

getSelectedObject

public abstract 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.

getPresentationHeight

public abstract int getPresentationHeight()

Retrieveis the height of this view, in pixels.

Returns:

The height of the this view, in pixels.

getPresentationWidth

public abstract int getPresentationWidth()

Retrieves the width of this view, in pixels.

Returns:

The width of the this view, in pixels.

setName

public final void setName(java.lang.String n)

Specifies the name of this view.

Overrides:

setName in class java.awt.Component

Parameters:

n - The name to use for this view.

getName

public final java.lang.String getName()

Retrieves the name of this view.

Overrides:

getName in class java.awt.Component

Returns:

The name of this view.

setLocalName

public final void setLocalName(java.lang.String n)

Specifies a local name for this view. The name of the view should be constant in all versions of an application. The local name should be a translation of the name into the local language.

Parameters:

n - The local name of this view bean.

getLocalName

public final java.lang.String getLocalName()

Retrieves the local name for this view. The local name should be a translation of the name, into the local language.

Returns:

The local name of this view.

setDescription

public final void setDescription(java.lang.String n)

Specifies a description for this view.

Parameters:

n - The description to use for this view.

getDescription

public final java.lang.String getDescription()

Retrieves the description of this view.

Returns:

The description of this view.

setDrillingEnabled

public final void setDrillingEnabled(boolean b)

Specifies whether drilling is allowed in this view. Drilling is enabled by default.

Parameters:

b - true to enable drilling; false to disable drilling.

isDrillingEnabled

public final boolean isDrillingEnabled()

Indicates whether drilling is allowed in this view.

Returns:

true if drilling is enabled, false if drilling is disabled.

setStartRow

public abstract void setStartRow(int r)

Deprecated. As of 2.6.0.27, replaced by GridView.setStartRow(int) or by Graph.setStartSeries(int) or by Graph.setStartGroup(int)

Specifies the first row of data to display in this view.

Parameters:

r - The first row of data to display.

getStartRow

public abstract int getStartRow()

Deprecated. As of 2.6.0.27, replaced by GridView.getStartRow() or by Graph.getStartSeries() or by Graph.getStartGroup()

Retrieves the first row of data that this view currently displays.

Returns:

The first row of data that this view displays.

setStartColumn

public abstract void setStartColumn(int c)

Deprecated. As of 2.6.0.27, replaced by GridView.setStartColumn(int) or by Graph.setStartGroup(int) or by Graph.setStartSeries(int).

Specifies the first column of data that this view currently displays.

Parameters:

c - The first column of data to display.

getStartColumn

public abstract int getStartColumn()

Deprecated. As of 2.6.0.27, replaced by GridView.getStartColumn() or by Graph.getStartGroup() or by Graph.getStartSeries().

Retrieves the first column of data that this view currently displays.

Returns:

The first column of data that this view displays.

setPopupManager

public void setPopupManager(PopupManager p)

Specifies a popup manager for this view. You implement a popup manager to display popup menus in this view.

Parameters:

p - The popup manager for this view.

getPopupManager

public PopupManager getPopupManager()

Retrieves the popup manager for this view.

Returns:

The popup manager for this view.

setRolloverTextManager

public void setRolloverTextManager(RolloverTextManager rm)

Specifies the rollover text manager for this view. You implement a rollover text manager to display text when the mouse moves over an area of this view.

Parameters:

rm - The rollover text manager for this view.

getRolloverTextManager

public RolloverTextManager getRolloverTextManager()

Retrieves the rollover text manager for this view.

Returns:

The rollover text manager for this view.

getPhysicalComponents

public java.util.Vector getPhysicalComponents()

Retrieves a Vector of the physical components in this view. Physical components are objects that extend JComponent and have physical Java manifestations, as opposed to virtual components that extend Object and have only a logical Java manifestation.

For a GridView, the objects in the vector include components like the title, subtitle, footnote, data body, headers, and the paging control. For a Graph, the vector includes only the PFJ object and the paging control.

Returns:

The physical components in this view.

getModel

public Model getModel()

Retrieves the model for this Dataview. In the Model-View-Controller architecture, the model is responsible for handling the data that is displayed in a view. In the full set of BI Beans, the DataSource is the "big" model. The model that this method returns interacts with the DataSource, retrieving data and having the data formatted so that the view can display it.

Specified by:

getModel in interface DataviewCommon

Returns:

The Model for this Dataview.

getController

public Controller getController()

Retrieves the controller for this Dataview. In the Model-View-Controller architecture, the controller is responsible for attending to mouse events and key events.

Returns:

The Controller for this Dataview.

setLocale

public void setLocale(java.util.Locale loc)

Specifies the Locale for this Dataview.

Overrides:

setLocale in class java.awt.Component

Parameters:

loc - The Locale for this Dataview.

getLocale

public java.util.Locale getLocale()

Retrieves the Locale that this Dataview uses.

Specified by:

getLocale in interface DataviewCommon

Overrides:

getLocale in class java.awt.Component

Returns:

loc The Locale for this Dataview.

getXML

public java.lang.String getXML(boolean allProperties)

Retrieves the XML string for this Dataview. The XML can include values for all of the properties in the Dataview, or, for better performance, it can include only the values that are different from the default values.

Notes: This method sets the current version as the version in the XML.

The XML does not contain attributes for the Locale property or the XMLValidated property.

Parameters:

allProperties - true to retrieve XML for all properties, false to retrieve XML only for properties whose values are different from the default property values.

Returns:

The XML string for this Dataview.

writeXML

public void writeXML(java.io.OutputStream stream,
                     boolean allProperties)

Writes XML for this Dataview to an output stream. The XML can include values for all of the properties in the Dataview, or, for better performance, it can include only the values that are different from the default values.

Notes: This method sets the current version as the version in the XML.

The XML does not contain attributes for the Locale property or the XMLValidated property.

Parameters:

stream - The output stream to which to write the XML.

allProperties - true to write out XML for all properties, false to write out XML only for properties whose values are different from the default property values.

getPagingControl

public PagingControl getPagingControl()

Retrieves the paging control for this view. The paging control provides UI for changing the page of data that appears in this view.

Returns:

The paging control for this view. If there is no paging control for this view, returns null.

setPagingControlVisible

public void setPagingControlVisible(boolean v)

Specifies whether the paging control appears in this view.

Specified by:

setPagingControlVisible in interface PagingControlAttributes

Parameters:

v - true to make the paging control visible, false to hide it.

isPagingControlVisible

public boolean isPagingControlVisible()

Indicates whether the paging control appears in this view.

Specified by:

isPagingControlVisible in interface PagingControlAttributes

Returns:

true if the paging control appears in this view, false if it does not.

getViewType

public abstract int getViewType()

Retrieves the specific type of subclass of this Dataview. This method is implemented in subclasses of Dataview.

Specified by:

getViewType in interface UIDataview

Returns:

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

See Also:

VIEW_TYPE_CROSSTAB, VIEW_TYPE_GRAPH, VIEW_TYPE_TABLE

setEnabled

public void setEnabled(boolean enabled)

Specifies whether this Dataview is enabled. When a Dataview is disabled, it is visible, but users cannot operate on the Dataview.

Overrides:

setEnabled in class javax.swing.JComponent

Parameters:

enabled - true to enable this Dataview, false to disable it.

resetToDefault

public void resetToDefault(int reset)

Resets properties of this Dataview to their default values. The reset parameter determines whether to reset only the properties or to reset the properties and remove registered listeners and callbacks.

This method is helpful when you want to reuse a Dataview rather than instantiate a new one.

Parameters:

reset - A constant that indicates how much to reset. Valid constants are listed in the See Also section. If you pass an invalid value or RESET_NONE, then this method logs a message with the error handler and does not change any properties.

See Also:

RESET_XML_PROPERTIES, RESET_EVERYTHING

readXML

public abstract boolean readXML(java.io.InputStream stream,
                                int reset)
                         throws BIIOException,
BISAXException,
BIParseException

Applies XML to this Dataview, from a String. This method reads the XML from xmlString and applies its attribute settings to this Dataview. The reset parameter determines how much of the Dataview to reset before applying XML. In general, you can:

• Apply the XML to the current Dataview without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this Dataview

Resetting returns property values in the Dataview to the default values for the version that is specified in the XML.

Parameters:

stream - The XML to apply to this Dataview.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this Dataview, false if an IO exception occurs.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

RESET_NONE, RESET_XML_PROPERTIES, RESET_EVERYTHING

setXML

public abstract boolean setXML(java.lang.String xmlString,
                               int reset)
                        throws BIIOException,
BISAXException,
BIParseException

Applies XML to this Dataview, from a String. This method reads the XML from xmlString and applies its attribute settings to this Dataview. The reset parameter determines how much of the Dataview to reset before applying XML. In general, you can:

• Apply the XML to the current Dataview without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this Dataview

Resetting returns property values in the Dataview to the default values for the version that is specified in the XML.

Parameters:

xmlString - The XML to apply to this Dataview.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this Dataview, false if an IO exception occurs.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

RESET_NONE, RESET_XML_PROPERTIES, RESET_EVERYTHING

setSwapAllowed

public abstract void setSwapAllowed(boolean swap)

Specifies whether users can swap layers in this view. When SwapAllowed is true, then users can click the two layers that they want to swap, in order to swap the layers. The view will then ask the data source to perform a pivot of type DataDirector.PIVOT_SWAP.

When SwapAllowed is false, then users must move the two layers separately, and the view will ask for two separate pivot actions of type DataDirector.PIVOT_MOVE_BEFORE or DataDirector.PIVOT_MOVE_AFTER.

By default, swapping is disabled.

Parameters:

swap - true to enable swapping, false to disable it.

See Also:

isSwapAllowed(), DataDirector

isSwapAllowed

public abstract boolean isSwapAllowed()

Indicates whether swapping is allowed in this view. When this method returns true, then users can swap items by clicking the two items. When this method returns false, then users must move each item separately.

Returns:

true if swapping is enabled, false if it is not.

See Also:

setSwapAllowed(boolean)

cleanUp

public void cleanUp()

Clears the memory of the view. Call this method when you no longer need this view.

getPersistableAttributes

public abstract PersistableAttributes getPersistableAttributes(PersistableAttributes attrs)

Retrieves the attributes of this Dataview, for searching. This method adds the attributes that this Dataview defines to the attributes that the application has specified. The attributes are used by the persistence service, when users search the repository for components that have particular attribute values.

Specified by:

getPersistableAttributes in interface Persistable

Parameters:

attrs - The searchable attributes that the application has specified for this Dataview.

Returns:

A PersistableAttributes that includes the application specified attributes as well as the attributes that are specific to this Dataview.

setPersistableAttributes

public void setPersistableAttributes(PersistableAttributes attrs)

Specifies persistable attributes that can be used in searches of the repository. This implementation does nothing. Only properties of the Dataview itself can be used as persistable attributes.

Specified by:

setPersistableAttributes in interface Persistable

Parameters:

attrs - Any PersistableAttributes.

setXMLAsString

public abstract boolean setXMLAsString(java.lang.String xml)
                                throws BIPersistenceException

Specifies the XML representation of this Dataview. The persistence service calls this method when the view is restored from the BI Beans Catalog. Application developers should not call this method. To load XML from a file, call setXML or readXML.

Specified by:

setXMLAsString in interface StringXMLizable

Parameters:

xml - The XML representation of the view.

Returns:

true if the XML was successfully set, false if not.

Throws:

BIPersistenceException - If a problem occurs in setting the XML.

See Also:

readXML(java.io.InputStream, int), setXML(java.lang.String, int)

getPersistableComponents

public AggregateInfo[] getPersistableComponents()

Retrieves the persistable components that this Dataview aggregates. Dataview objects aggregate the data source that defines the data that view displays.

The persistence service calls this method when the view is restored from the BI Beans Catalog. Application developers should not call this method.

Specified by:

getPersistableComponents in interface Persistable

Returns:

The data source for this Dataview, in an AggregateInfo array.

getXMLAsString

public java.lang.String getXMLAsString()

Retrieves the XML representation of this Dataview. This method is called by the persistence service when you save the Dataview to the BI Beans Catalog.

This method calls getXML(false), so the XML that is stored in the Catalog has only property values that are different from the default values.

Application developers should not call this method. To create a file that has the XML for this Dataview, call the writeXML method or the getXML method.

Specified by:

getXMLAsString in interface StringXMLizable

Returns:

The XML representation of this Dataview.

See Also:

getXML(boolean), writeXML(java.io.OutputStream, boolean)

setHTMLPagingControlAutosubmit

public void setHTMLPagingControlAutosubmit(boolean autosubmit)

Specifies whether the paging control automatically submits information when someone changes a page dimension member. By default, automatic submission is disabled.

This property is used for the thin beans only.

Specified by:

setHTMLPagingControlAutosubmit in interface DataviewCommon

Parameters:

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

isHTMLPagingControlAutosubmit

public boolean isHTMLPagingControlAutosubmit()

Indicates whether automatic submssion of information is enabled for the paging control. This property is used for the thin beans only.

Specified by:

isHTMLPagingControlAutosubmit in interface DataviewCommon

Returns:

true if automatic submission is enabled, false if it is disabled.

setHTMLPagingControlWidth

public void setHTMLPagingControlWidth(int width)

Specifies the number of page items that are displayed in the paging control before it wraps to the next line. If you set width to -1, then all page items will be displayed on the same line. By default, width is set to 3. This property is used for the thin beans only.

Specified by:

setHTMLPagingControlWidth in interface DataviewCommon

Parameters:

width - The number of page items to display before wrapping.

getHTMLPagingControlWidth

public int getHTMLPagingControlWidth()

Retrieves the number of page items that are displayed in the paging control before it wraps to the next line. The default value is 3. This property is used for the thin beans only.

Specified by:

getHTMLPagingControlWidth in interface DataviewCommon

Returns:

The number of page items to display before wrapping. A return of -1 indicates that all page items appear on the same line.