Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.graph.gui
Class BaseAxis

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.graph.gui.BasePanel
                                |
                                +--oracle.dss.graph.gui.BaseAxis
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, javax.swing.event.CaretListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.event.ItemListener, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable
Direct Known Subclasses:
GroupAxis, ValueAxis

public abstract class BaseAxis
extends BasePanel
implements java.beans.PropertyChangeListener, java.awt.event.ItemListener, java.awt.event.ActionListener, javax.swing.event.CaretListener

Defines an axis panel. This class contains common user-interface elements that all axis panels require.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent

 

Field Summary
static int ALL_ERRORS
          Error type: Display all errors but no warnings.
static int ALL_ERRORS_AND_WARNINGS
          Error type: Display all errors and warnings.
static int NON_DATA_ERRORS
          Error type: Display only errors that do not require access to the data that the graph displays.
static int NONE
          Error type: Do not display errors and warnings.
static java.lang.String PROPERTY_AXIS_COLOR
          Property: Axis Color.
static java.lang.String PROPERTY_AXIS_TITLE
          Property: Axis Title.
static java.lang.String PROPERTY_AXIS_VISIBLE
          Property: Axis Visible.
static java.lang.String PROPERTY_LINE_WIDTH
          Property: Line Width.
static int WARNINGS
          Error type: Display warnings only.

 

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
BaseAxis(UIGraph graph)
          Constructor.

 

Method Summary
 void cleanUp()
          Clean up the inner classes and components
 java.lang.String getApplicationName()
          Retrieves the name of the application that uses this panel.
 java.awt.Color[][] getColorPalette()
          Retreives the grid of colors used by color choosers used in this panel.
 ErrorHandler getErrorHandler()
          Retrieves the ErrorHandler used by this class to log errors
 int getErrorTypes()
          Retrieves the type of errors and warnings that this panel displays to end users.
 java.awt.Dimension getMinimumSize()
          Retrieves the minimum size of this panel.
 java.awt.Dimension getPreferredSize()
          Retrieves the size at which this panel looks best.
 void setApplicationName(java.lang.String name)
          Specifies the name of application that uses this panel.
 void setColorPalette(java.awt.Color[][] colors)
          Specifies the grid of colors to use in color palettes of border and background color choosers.
 void setErrorHandler(ErrorHandler eh)
          Specifies the ErrorHandler to use when errors need to be logged
 void setErrorTypes(int types)
          Specifies the type of errors and warnings to be displayed to the user.
 void setGraph(UIGraph graph)
          Specifies the graph whose properties this panel sets.
 void setLocale(java.util.Locale loc)
          Specifies the locale for this panel.

 

Methods inherited from class oracle.dss.graph.gui.BasePanel
apply, 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.beans.PropertyChangeListener
propertyChange

 

Methods inherited from interface java.awt.event.ItemListener
itemStateChanged

 

Methods inherited from interface java.awt.event.ActionListener
actionPerformed

 

Methods inherited from interface javax.swing.event.CaretListener
caretUpdate

 

Field Detail

PROPERTY_LINE_WIDTH

public static final java.lang.String PROPERTY_LINE_WIDTH
Property: Line Width. Use this constant when listening for changes in the option that sets the width of an axis.

PROPERTY_AXIS_COLOR

public static final java.lang.String PROPERTY_AXIS_COLOR
Property: Axis Color. Use this constant when listening for changes in the option that sets the color of an axis.

PROPERTY_AXIS_TITLE

public static final java.lang.String PROPERTY_AXIS_TITLE
Property: Axis Title. Use this constant when listening for changes in the option that sets the title for an axis.

PROPERTY_AXIS_VISIBLE

public static final java.lang.String PROPERTY_AXIS_VISIBLE
Property: Axis Visible. Use this constant when listening for changes in the option that specifies whether the axis is visible in the graph.

ALL_ERRORS_AND_WARNINGS

public static final int ALL_ERRORS_AND_WARNINGS
Error type: Display all errors and warnings. When the ErrorTypes property is set to this value, then this panel displays all errors and warnings to the user.

Error conditions are settings of the maximum axis value, minimum axis value, and increment that cannot be accommodated by the graph. For example, users will incur an error if they set the axis maximum to a value less than the axis minimum.

Warning conditions are settings that can be accommodated by the graph, but are likely to distort the data in the graph or to look strange. For example, users will incur a warning if they set the axis maximum to a value lower than the highest value in the data that the graph displays. In this situation, the marker for the highest data value is truncated, making the data value appear less than it is.

See Also:
setErrorTypes(int)

NONE

public static final int NONE
Error type: Do not display errors and warnings. When the ErrorTypes property is set to this value, then this panel does not report any errors or warnings to the user.
See Also:
setErrorTypes(int)

ALL_ERRORS

public static final int ALL_ERRORS
Error type: Display all errors but no warnings. When the ErrorTypes property is set to this value, then this panel displays all errors to the user, but it does not display any warning messages.

Error conditions are settings of the maximum axis value, minimum axis value, and increment that cannot be accommodated by the graph. For example, users will incur an error if they set the axis maximum to a value less than the axis minimum.

Warning conditions are settings that can be accommodated by the graph, but are likely to distort the data in the graph or to look strange. For example, users will incur a warning if they set the axis maximum to a value lower than the highest value in the data that the graph displays. In this situation, the marker for the highest data value is truncated, making the data value appear less than it is.

See Also:
setErrorTypes(int)

WARNINGS

public static final int WARNINGS
Error type: Display warnings only. When the ErrorTypes property is set to this value, then this panel displays warnings to the user, but it does not display any error messages.

Error conditions are settings of the maximum axis value, minimum axis value, and increment that cannot be accommodated by the graph. For example, users will incur an error if they set the axis maximum to a value less than the axis minimum.

Warning conditions are settings that can be accommodated by the graph, but are likely to distort the data in the graph or to look strange. For example, users will incur a warning if they set the axis maximum to a value lower than the highest value in the data that the graph displays. In this situation, the marker for the highest data value is truncated, making the data value appear less than it is.

See Also:
setErrorTypes(int)

NON_DATA_ERRORS

public static final int NON_DATA_ERRORS
Error type: Display only errors that do not require access to the data that the graph displays. When the ErrorTypes property is set to this value, then this panel displays only those errors that do not require examination of the data that the graph displays. For example, with this setting, the panel displays an error message if the maximum value is set lower than the minimum value, but it would not display an error message if the increment is set higher than the distance between the lowest data value in the graph and the highest data value in the graph.
See Also:
setErrorTypes(int)
Constructor Detail

BaseAxis

public BaseAxis(UIGraph graph)
Constructor.
Parameters:
graph - The graph to which this panel belongs.
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.

setColorPalette

public void setColorPalette(java.awt.Color[][] colors)
Specifies the grid of colors to use in color palettes of border and background color choosers. 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 used in this panel.
Returns:
the two dimesional array of Colors

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.

setErrorHandler

public void setErrorHandler(ErrorHandler eh)
Specifies the ErrorHandler to use when errors need to be logged

getErrorHandler

public ErrorHandler getErrorHandler()
Retrieves the ErrorHandler used by this class to log errors

setLocale

public void setLocale(java.util.Locale loc)
Specifies the locale for this panel.
Overrides:
setLocale in class java.awt.Component
Parameters:
loc - The locale to use for this panel.

getPreferredSize

public java.awt.Dimension getPreferredSize()
Retrieves the size at which this 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 this panel.

getMinimumSize

public java.awt.Dimension getMinimumSize()
Retrieves the minimum size of this panel. The minimum size is the smallest size that the panel can be made without truncating its components. 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 this panel can be made without truncating its components.

setErrorTypes

public void setErrorTypes(int types)
Specifies the type of errors and warnings to be displayed to the user. By default, all errors and warnings are displayed.
Parameters:
type - A constant that represents the level of errors that you want to display. You can use the OR operator (|) to combine settings. Valid constants are listed in the See Also section.
See Also:
ALL_ERRORS_AND_WARNINGS, ALL_ERRORS, NON_DATA_ERRORS, WARNINGS, NONE

getErrorTypes

public int getErrorTypes()
Retrieves the type of errors and warnings that this panel displays to end users.
Returns:
A constant that specifies the level of error that are reported to end users. Valid constants are listed in the See Also section.
See Also:
ALL_ERRORS_AND_WARNINGS, ALL_ERRORS, NON_DATA_ERRORS, WARNINGS, NONE

cleanUp

public void cleanUp()
Clean up the inner classes and components
Overrides:
cleanUp in class BasePanel

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.