oracle.dss.gridView.gui
Class OptionsPanel

oracle.dss.gridView.gui.OptionsPanel

All Implemented Interfaces:

javax.swing.event.ChangeListener, java.util.EventListener, HelpContext, java.awt.event.ItemListener, java.beans.PropertyChangeListener

public class OptionsPanel

implements java.awt.event.ItemListener, java.beans.PropertyChangeListener, javax.swing.event.ChangeListener, HelpContext

Defines the gridView Options panel. End-users use the gridView Options panel to set options of table or crosstab

This class fires propertyChange events for every property that is exposed in this panel.

See Also:

Serialized Form

Field Summary

static java.lang.String	INLINE
static java.lang.String	OUTLINE
static java.lang.String	PROPERTY_3D_GRID_VISIBLE Property: 3D Grid Line.
static java.lang.String	PROPERTY_BACKGROUND_PICTURE_NAME Property: Background Picture Name.
static java.lang.String	PROPERTY_BACKGROUND_VISIBLE Property: Background Picture Visible.
static java.lang.String	PROPERTY_COLUMN_HEADERS_VISIBLE Property: Column Headers Visible.
static java.lang.String	PROPERTY_HORIZONTAL_GRID_COLOR Property: Horizontal Grid Color.
static java.lang.String	PROPERTY_HORIZONTAL_GRID_LINE_WIDTH Property: Horizontal Grid Line Width.
static java.lang.String	PROPERTY_HORIZONTAL_GRID_VISIBLE Property: Horizontal Grid Visible.
static java.lang.String	PROPERTY_ROW_HEADERS_STYLE Property: Row Headers Style.
static java.lang.String	PROPERTY_ROW_HEADERS_VISIBLE Property: Row Headers Visible.
static java.lang.String	PROPERTY_ROW_NUMBERS_VISIBLE Property: Row Numbers Visible.
static java.lang.String	PROPERTY_VERTICAL_GRID_COLOR Property: Vertical Grid Color.
static java.lang.String	PROPERTY_VERTICAL_GRID_LINE_WIDTH Property: Vertical Grid Line Width.
static java.lang.String	PROPERTY_VERTICAL_GRID_VISIBLE Property: Vertical Grid Visible.

Constructor Summary

OptionsPanel(UIGridView gridView)
Constructor.

Method Summary

boolean	apply() Applies to the gridView the changes that have been made to this panel.
void	cleanUp() Clean up memory space
java.lang.String	getApplicationName() Retrieves the name of the application that uses this panel.
ErrorHandler	getErrorHandler() Retrieves the error handler that this Options uses.
UIGridView	getGridView() Retrive the gridView whose properties this panel sets.
java.lang.String	getHelpContextID() Retrieves the Help context ID for this panel.
java.awt.Dimension	getMinimumSize() Retrieves the minimum size of the Plot Area panel.
java.awt.Dimension	getPreferredSize() Retrieves the size at which the Plot Area panel looks best.
boolean	isHelpEnabled() Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
boolean	isHorizontalGridLineShow()
boolean	isVerticalGridLineShow()
void	setApplicationName(java.lang.String name) Specifies the name of application that uses this panel.
void	setErrorHandler(ErrorHandler eh) Specifies an error handler for this Options.
void	setGridView(UIGridView gridView) Specifies the gridView whose properties this panel sets.
void	setHelpContextID(java.lang.String strHelpContextID) Sets the Help context ID for this panel.
void	setHelpEnabled(boolean bValue) Specifies whether a Help button in a dialog box that is displayed by this panel, is displayed.
void	setHorizontalGridLineShow(boolean show)
void	setLocale(java.util.Locale loc) Specifies the current Locale that the gridView uses.
void	setVerticalGridLineShow(boolean show)

Methods inherited from interface java.awt.event.ItemListener

itemStateChanged

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Methods inherited from interface javax.swing.event.ChangeListener

stateChanged

Field Detail

PROPERTY_HORIZONTAL_GRID_VISIBLE

public static final java.lang.String PROPERTY_HORIZONTAL_GRID_VISIBLE

Property: Horizontal Grid Visible. Use this constant when listening for changes in the option that specifies whether horizontal grid lines appear. To apply this change, the apply method of this panel sets the Visible property of the object that represents horizontal grid lines.

PROPERTY_HORIZONTAL_GRID_COLOR

public static final java.lang.String PROPERTY_HORIZONTAL_GRID_COLOR

Property: Horizontal Grid Color. Use this constant when listening for changes in the option that specifies the color of horizontal grid lines. To apply this change, the apply method of this panel sets the LineColor property of the object that represents horizontal grid lines.

PROPERTY_HORIZONTAL_GRID_LINE_WIDTH

public static final java.lang.String PROPERTY_HORIZONTAL_GRID_LINE_WIDTH

Property: Horizontal Grid Line Width. Use this constant when listening for changes in the option that specifies the width of horizontal grid lines. To apply this change, the apply method of this panel sets the LineWidth property of the object that represents horizontal grid lines.

PROPERTY_VERTICAL_GRID_VISIBLE

public static final java.lang.String PROPERTY_VERTICAL_GRID_VISIBLE

Property: Vertical Grid Visible. Use this constant when listening for changes in the option that specifies whether vertical grid lines appear. To apply this change, the apply method of this panel sets the Visible property of the object that represents vertical grid lines.

PROPERTY_VERTICAL_GRID_COLOR

public static final java.lang.String PROPERTY_VERTICAL_GRID_COLOR

Property: Vertical Grid Color. Use this constant when listening for changes in the option that specifies the color of vertical grid lines. To apply this change, the apply method of this panel sets the LineColor property of the object that represents vertical grid lines.

PROPERTY_VERTICAL_GRID_LINE_WIDTH

public static final java.lang.String PROPERTY_VERTICAL_GRID_LINE_WIDTH

Property: Vertical Grid Line Width. Use this constant when listening for changes in the option that specifies the width of vertical grid lines. To apply this change, the apply method of this panel sets the LineWidth property of the object that represents vertical grid lines.

PROPERTY_3D_GRID_VISIBLE

public static final java.lang.String PROPERTY_3D_GRID_VISIBLE

Property: 3D Grid Line.

PROPERTY_BACKGROUND_VISIBLE

public static final java.lang.String PROPERTY_BACKGROUND_VISIBLE

Property: Background Picture Visible.

PROPERTY_BACKGROUND_PICTURE_NAME

public static final java.lang.String PROPERTY_BACKGROUND_PICTURE_NAME

Property: Background Picture Name.

PROPERTY_COLUMN_HEADERS_VISIBLE

public static final java.lang.String PROPERTY_COLUMN_HEADERS_VISIBLE

Property: Column Headers Visible.

PROPERTY_ROW_HEADERS_VISIBLE

public static final java.lang.String PROPERTY_ROW_HEADERS_VISIBLE

Property: Row Headers Visible.

PROPERTY_ROW_NUMBERS_VISIBLE

public static final java.lang.String PROPERTY_ROW_NUMBERS_VISIBLE

Property: Row Numbers Visible.

PROPERTY_ROW_HEADERS_STYLE

public static final java.lang.String PROPERTY_ROW_HEADERS_STYLE

Property: Row Headers Style.

OUTLINE

public static final java.lang.String OUTLINE

INLINE

public static final java.lang.String INLINE

Constructor Detail

OptionsPanel

public OptionsPanel(UIGridView gridView)

Constructor.

Parameters:

gridView - The GridView to which this object belongs.

Method Detail

setGridView

public void setGridView(UIGridView gridView)

Specifies the gridView whose properties this panel sets. This panel gets information from the gridView that is specified either in this method or in the constructor.

Parameters:

gridView - The gridView whose properties this panel sets.

getGridView

public UIGridView getGridView()

Retrive the gridView whose properties this panel sets. This panel gets information from the gridView that is specified either in this method or in the constructor.

Parameters:

gridView - The gridView whose properties this panel sets.

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Specifies an error handler for this Options. If an error handler has been set, then this Options reports error conditions to the handler. Otherwise, it prints the stack trace.

Parameters:

eh - The error handler that this panel should use.

getErrorHandler

public ErrorHandler getErrorHandler()

Retrieves the error handler that this Options uses.

Returns:

The error handler for this panel, or null if no error handler has been set.

cleanUp

public void cleanUp()

Clean up memory space

setLocale

public void setLocale(java.util.Locale loc)

Specifies the current Locale that the gridView uses.

Overrides:

setLocale in class java.awt.Component

Parameters:

loc - The current Locale.

apply

public boolean apply()

Applies to the gridView the changes that have been made to this panel. Normally, you call this method in the listener for the container's OK button.

getPreferredSize

public java.awt.Dimension getPreferredSize()

Retrieves the size at which the Plot Area panel looks best. The size is expressed as a Dimension object. If no panel size has been specified, then the preferred size is the default size of the panel.

Overrides:

getPreferredSize in class javax.swing.JComponent

Returns:

A Dimension object that specifies the size for the Plot Area panel.

getHelpContextID

public java.lang.String getHelpContextID()

Retrieves the Help context ID for this panel. The Help context ID is the full class path for this panel. This Help context ID is used when listening for the user event to display Help for this panel.

Specified by:

getHelpContextID in interface HelpContext

Returns:

The Help context ID for this panel.

setHelpContextID

public void setHelpContextID(java.lang.String strHelpContextID)

Sets the Help context ID for this panel.

Specified by:

setHelpContextID in interface HelpContext

Following copied from interface: oracle.dss.util.help.HelpContext

Parameters:

strHelpContextID - a String value that represents the Help context ID.

setApplicationName

public void setApplicationName(java.lang.String name)

Specifies the name of application that uses this panel. Passing the name of your application to this message ensures that alerts that this panel produces are labeled as coming from your application.

Parameters:

name - The name to display in alerts that this panel produces. In localized versions, pass a localized String.

getApplicationName

public java.lang.String getApplicationName()

Retrieves the name of the application that uses this panel. This is the application that alerts appear to come from.

Returns:

The name of the application that uses this panel.

getMinimumSize

public java.awt.Dimension getMinimumSize()

Retrieves the minimum size of the Plot Area panel. The minimum size is the smallest size that the panel can be made without truncating its components in the UI. The size is expressed as a Dimension object.

Overrides:

getMinimumSize in class javax.swing.JComponent

Returns:

A Dimension object that specifies the smallest size that the panel can be made without truncating its components in the UI.

setHelpEnabled

public void setHelpEnabled(boolean bValue)

Specifies whether a Help button in a dialog box that is displayed by this panel, is displayed.

For example, suppose that this panel had a font button and that font button displayed a font dialog box. If that font dialog box had a Help button, then this method would specify whether that Help button is displayed.

Parameters:

bValue - true to display the Help button, false to hide it.

isHelpEnabled

public boolean isHelpEnabled()

Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.

For example, suppose that this panel had a font button and that font button displayed a font dialog box. If that font dialog box had a Help button, then this method would tell you whether that Help button is displayed.

Returns:

true if the Help button is hidden, false if it is displayed.

setHorizontalGridLineShow

public void setHorizontalGridLineShow(boolean show)

isHorizontalGridLineShow

public boolean isHorizontalGridLineShow()

setVerticalGridLineShow

public void setVerticalGridLineShow(boolean show)

isVerticalGridLineShow

public boolean isVerticalGridLineShow()