oracle.dss.graph.gui
Class PlotArea

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.graph.gui.BasePanel
                                |
                                +--oracle.dss.graph.gui.PlotArea

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, HelpContext, java.awt.image.ImageObserver, java.awt.event.ItemListener, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable

public class PlotArea

extends BasePanel

implements java.awt.event.ActionListener, java.awt.event.ItemListener, java.beans.PropertyChangeListener, HelpContext

Defines the Plot Area panel. End-users use the Plot Area panel to set properties of the plot area of a graph and of components that appear on the plot area, such as major tick marks.

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

See Also:

PROPERTY_BACKGROUND_COLOR, PROPERTY_DATA_LABEL_POSITION, PROPERTY_DATA_LABEL_TEXT, PROPERTY_DATA_LABEL_VISIBLE, PROPERTY_DATA_TIPS_TEXT, PROPERTY_DATA_TIPS_VISIBLE, PROPERTY_HORIZONTAL_GRID_COLOR, PROPERTY_HORIZONTAL_GRID_LINE_WIDTH, PROPERTY_HORIZONTAL_GRID_VISIBLE, PROPERTY_VERTICAL_GRID_COLOR, PROPERTY_VERTICAL_GRID_LINE_WIDTH, PROPERTY_VERTICAL_GRID_VISIBLE, PlotArea, Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static int	COLOR_COLUMN Series column: Color.
static int	FITLINE_COLUMN Series column: Fitline.
static int	LINE_COLUMN Series column: Line.
static int	MARKER_SHAPE_COLUMN Series column: Marker shape.
static int	MARKER_TYPE_COLUMN Series column: Marker type.
static java.lang.String	PROPERTY_BACKGROUND_COLOR Property: Background color.
static java.lang.String	PROPERTY_BORDER_COLOR Property: Border color.
static java.lang.String	PROPERTY_DATA_LABEL_POSITION Property: Data Label Position.
static java.lang.String	PROPERTY_DATA_LABEL_TEXT Property: Data Label Text.
static java.lang.String	PROPERTY_DATA_LABEL_VISIBLE Property: Data Label Visible.
static java.lang.String	PROPERTY_DATA_MARKER_VISIBLE Property: Data Marker Visible.
static java.lang.String	PROPERTY_DATA_TIPS_TEXT Property: Data Tips Text.
static java.lang.String	PROPERTY_DATA_TIPS_VISIBLE Property: Data Tips 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_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.
static int	YAXIS_COLUMN Series column: Y-axis assignment.

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

PlotArea(UIGraph graph)
Constructor.

PlotArea(UIGraph graph, int excludeColumns)
Constructor that specifies columns to hide in this panel.

Method Summary

void	apply() Applies to the graph the changes that have been made to this panel.
void	cleanUp() Clean up memory and resource used by Series
java.awt.Color[][]	getColorPalette() Retreives the grid of colors used by color choosers in this panel.
ErrorHandler	getErrorHandler() Retrieves the error handler that this PlotArea uses.
java.lang.String	getHelpContextID() Retrieves the Help context ID for this panel.
oracle.bali.ewt.help.HelpProvider	getHelpProvider() Gets the Help provider for the Plot Area 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.
int	getSelectedSeries()
boolean	isHelpEnabled() Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
void	setColorPalette(java.awt.Color[][] colors) Specifies the grid of colors to use in color palettes of color choosers used in this panel.
void	setErrorHandler(ErrorHandler eh) Specifies an error handler for this PlotArea.
void	setFocusComponent() Requests focus for a default component.
void	setGraph(UIGraph graph) Specifies the graph 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	setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider) Sets the Help provider for the Plot Area panel.
void	setLocale(java.util.Locale loc) Specifies the current Locale that the graph uses.
void	setSelectedSeries(int series)

Methods inherited from class oracle.dss.graph.gui.BasePanel

createSeparator, setTitleText

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, 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, getNextFocusableComponent, 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, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, 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, getLocale, getLocation, getLocationOnScreen, getName, 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, setName, 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 java.awt.event.ActionListener

actionPerformed

Methods inherited from interface java.awt.event.ItemListener

itemStateChanged

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Field Detail

PROPERTY_BACKGROUND_COLOR

public static final java.lang.String PROPERTY_BACKGROUND_COLOR

Property: Background color. Use this constant when listening for changes in the background color option in this panel. To apply this change, the apply method of this panel sets the FillColor property of the object that represents the plot area.

PROPERTY_BORDER_COLOR

public static final java.lang.String PROPERTY_BORDER_COLOR

Property: Border color. Use this constant when listening for changes in the border color option in this panel. To apply this change, the apply method of this panel sets the BorderColor property of the object that represents the plot area.

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.

See Also:

Y1MajorTick.setVisible(boolean), Y2MajorTick.setVisible(boolean), O1MajorTick.setVisible(boolean), X1MajorTick.setVisible(boolean)

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.

See Also:

BaseBorderLine.setLineColor(java.awt.Color), BaseBorderLine.setLineColor(java.awt.Color), BaseBorderLine.setLineColor(java.awt.Color), BaseBorderLine.setLineColor(java.awt.Color)

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.

See Also:

BaseBorderLine.setLineWidth(int), BaseBorderLine.setLineWidth(int), BaseBorderLine.setLineWidth(int), BaseBorderLine.setLineWidth(int)

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.

See Also:

O1MajorTick.setVisible(boolean), X1MajorTick.setVisible(boolean), Y1MajorTick.setVisible(boolean), Y2MajorTick.setVisible(boolean)

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.

See Also:

BaseBorderLine.setLineColor(java.awt.Color), BaseBorderLine.setLineColor(java.awt.Color), BaseBorderLine.setLineColor(java.awt.Color), BaseBorderLine.setLineColor(java.awt.Color)

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.

See Also:

BaseBorderLine.setLineWidth(int), BaseBorderLine.setLineWidth(int), BaseBorderLine.setLineWidth(int), BaseBorderLine.setLineWidth(int)

PROPERTY_DATA_LABEL_POSITION

public static final java.lang.String PROPERTY_DATA_LABEL_POSITION

Property: Data Label Position. Use this constant when listening for changes in the option that specifies the position of data labels. To apply this change, the apply method of this panel sets the MarkerTextPlace property of the MarkerText object, or the setLabelPosition property of the Slice object.

See Also:

MarkerText.setMarkerTextPlace(int), Slice.setLabelPosition(int)

PROPERTY_DATA_LABEL_VISIBLE

public static final java.lang.String PROPERTY_DATA_LABEL_VISIBLE

Property: Data Label Visible. Use this constant when listening for changes in the option that specifies whether data labels appear in the graph. To apply this change, the apply method of this panel sets the Visible property of the MarkerText object, or the setLabelPosition property of the Slice object.

See Also:

MarkerText.setVisible(boolean), Slice.setLabelPosition(int)

PROPERTY_DATA_LABEL_TEXT

public static final java.lang.String PROPERTY_DATA_LABEL_TEXT

Property: Data Label Text. Use this constant when listening for changes in the option that specifies the kind of text that appears in data labels in pie graphs. To apply this change, the apply method of this panel sets the setTextType property of the SliceLabel object.

See Also:

SliceLabel.setTextType(int)

PROPERTY_DATA_TIPS_VISIBLE

public static final java.lang.String PROPERTY_DATA_TIPS_VISIBLE

Property: Data Tips Visible. Use this constant when listening for changes in the option that specifies whether data tips appear in the graph. To apply this change, the apply method of this panel sets the MarkerTooltipType property of the Graph object.

See Also:

Graph.setMarkerTooltipType(int)

PROPERTY_DATA_MARKER_VISIBLE

public static final java.lang.String PROPERTY_DATA_MARKER_VISIBLE

Property: Data Marker Visible. Use this constant when listening for changes in the option that specifies whether data marker appear in the graph.

PROPERTY_DATA_TIPS_TEXT

public static final java.lang.String PROPERTY_DATA_TIPS_TEXT

Property: Data Tips Text. Use this constant when listening for changes in the option that specifies the kind of information that appears in the data tips. To apply this change, the apply method of this panel sets the MarkerTooltipType property of the Graph object.

See Also:

Graph.setMarkerTooltipType(int)

COLOR_COLUMN

public static final int COLOR_COLUMN

Series column: Color. This constant represents the column for setting the color for a series.

See Also:

PlotArea(UIGraph, int)

LINE_COLUMN

public static final int LINE_COLUMN

Series column: Line. This constant represents the column for setting line thickness for a series. This column is appropriate for series that are displayed as lines, in a line graph or in a combination graph.

See Also:

PlotArea(UIGraph, int)

MARKER_SHAPE_COLUMN

public static final int MARKER_SHAPE_COLUMN

Series column: Marker shape. This constant represents the column for setting the shape of the marker for a series. This column is appropriate for series that are displayed as points.

See Also:

PlotArea(UIGraph, int)

YAXIS_COLUMN

public static final int YAXIS_COLUMN

Series column: Y-axis assignment. This constant represents column for assigning a series to the Y1- or to the Y2-axis. This column is appropriate for dual-Y graphs.

See Also:

PlotArea(UIGraph, int)

MARKER_TYPE_COLUMN

public static final int MARKER_TYPE_COLUMN

Series column: Marker type. This constant represents the column for setting the type of marker for a series. This column is appropriate for combination graphs.

See Also:

PlotArea(UIGraph, int)

FITLINE_COLUMN

public static final int FITLINE_COLUMN

Series column: Fitline. Constant that represents the column for setting the type of fitline that appears for a series. This column is appropriate for graphs that can display fitlines, such as bar graphs.

See Also:

PlotArea(UIGraph, int)

Constructor Detail

PlotArea

public PlotArea(UIGraph graph)

Constructor.

Parameters:

graph - The graph to which this object belongs.

PlotArea

public PlotArea(UIGraph graph,
                int excludeColumns)

Constructor that specifies columns to hide in this panel.

Parameters:

graph - The graph to which this object belongs.

excludeColumns - A constant that represents the columns to exclude for series. The constant ends with _COLUMN. You can combine the constants by using the OR operator (|).

See Also:

COLOR_COLUMN, LINE_COLUMN, MARKER_SHAPE_COLUMN, YAXIS_COLUMN, MARKER_TYPE_COLUMN, FITLINE_COLUMN

Method Detail

setGraph

public void setGraph(UIGraph graph)

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

Overrides:

setGraph in class BasePanel

Parameters:

graph - The graph whose properties this panel sets.

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

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

Parameters:

eh - The error handler that this panel should use.

setSelectedSeries

public void setSelectedSeries(int series)

getSelectedSeries

public int getSelectedSeries()

getErrorHandler

public ErrorHandler getErrorHandler()

Retrieves the error handler that this PlotArea uses.

Returns:

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

setColorPalette

public void setColorPalette(java.awt.Color[][] colors)

Specifies the grid of colors to use in color palettes of color choosers used in this panel. If the grid of colors are not specified, then a default color palatte is used. For example: if you need to provide 228 colors, you could provide an array of size 12 columns and 19 rows. When you want to call setColorPalette() and call setGraph() at the same time, first call setColorPalette() and then setGraph().

Parameters:

colors - two dimesional array of Colors

getColorPalette

public java.awt.Color[][] getColorPalette()

Retreives the grid of colors used by color choosers in this panel.

Returns:

the two dimesional array of Colors

cleanUp

public void cleanUp()

Clean up memory and resource used by Series

Overrides:

cleanUp in class BasePanel

setLocale

public void setLocale(java.util.Locale loc)

Specifies the current Locale that the graph uses.

Overrides:

setLocale in class java.awt.Component

Parameters:

loc - The current Locale.

apply

public void apply()

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

Overrides:

apply in class BasePanel

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.

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.

setHelpProvider

public void setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider)

Sets the Help provider for the Plot Area panel.

getHelpProvider

public oracle.bali.ewt.help.HelpProvider getHelpProvider()

Gets the Help provider 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, plus the flavor of Series panel that is currently displayed.

For example: If a dual-Y line graph is currently in use, then the Help context ID for the PlotArea panel is oracle.dss.graph.gui.PlotArea_F.

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.

See Also:

Series

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.

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.

setFocusComponent

public void setFocusComponent()

Requests focus for a default component. You can call this method whenever you instantiate this panel to enable mnemonic keys to take effect.

Overrides:

setFocusComponent in class BasePanel