<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">

Overview  Package   Class  Tree  Deprecated  Index  Help 

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

 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

oracle.dss.graph.gui
Class ValueAxis

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
                                      |
                                      +--oracle.dss.graph.gui.ValueAxis
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, javax.swing.event.CaretListener, java.util.EventListener, HelpContext, java.awt.image.ImageObserver, java.awt.event.ItemListener, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable
public class ValueAxis
extends BaseAxis
implements HelpContext

Defines the Value Axis panel. The Y-axis (Y1-axis or Y2-axis) is always the value axis.

The X-axis is the value axis in the following graph types:



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

See Also:
Serialized Form

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

 

Field Summary
static java.lang.String PROPERTY_AXIS_AUTO_MAX
          Property: Axis Auto Max.
static java.lang.String PROPERTY_AXIS_AUTO_MIN
          Property: Axis Auto Min.
static java.lang.String PROPERTY_AXIS_AUTO_TICK_STEP
          Property: Axis Auto Tick Step.
static java.lang.String PROPERTY_AXIS_LOG_BASE
          Property: Axis Logarithmic Base.
static java.lang.String PROPERTY_AXIS_LOG_SCALE
          Property: Axis Log Scale.
static java.lang.String PROPERTY_AXIS_MAJOR_TICK_STEP
          Property: Axis Major Tick Step.
static java.lang.String PROPERTY_AXIS_MAX_VALUE
          Property: Axis Max Value.
static java.lang.String PROPERTY_AXIS_MIN_VALUE
          Property: Axis Min Value.

 

Fields inherited from class oracle.dss.graph.gui.BaseAxis
ALL_ERRORS, ALL_ERRORS_AND_WARNINGS, NON_DATA_ERRORS, NONE, PROPERTY_AXIS_COLOR, PROPERTY_AXIS_TITLE, PROPERTY_AXIS_VISIBLE, PROPERTY_LINE_WIDTH, WARNINGS

 

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
ValueAxis(UIGraph graph, int componentID)
          Constructor.
ValueAxis(UIGraph graph, int componentID, int errorTypes)
          Constructor.

 

Method Summary
 void apply()
          Deprecated. As of 2.4.0.4, replaced by applyAfterCheck()
 boolean applyAfterCheck()
          Applies changes that were made in this panel, but only if they are valid.
 void cleanUp()
          Clean up memory and resources of value axis panel
 java.lang.String getHelpContextID()
          Retrieves the Help context ID for this panel.
 oracle.bali.ewt.help.HelpProvider getHelpProvider()
          Gets the Help provider for this panel.
 int getMaxMultiplier()
          Retrives the number by which the maximum data value is multiplied, to determine the setting of the axis maximum for which this panel reports a warning to end users.
 boolean isHelpEnabled()
          Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
 boolean isRepeatWarnings()
          Indicates if warnings should be displayed every time applyAfterCheck() method is called even if the values have not changed in the panel.
 void setColorPalette(java.awt.Color[][] colors)
          Specifies the grid of colors to use in color palettes of color choosers used in this panel.
 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 this panel.
 void setMaxMultiplier(int multiplier)
          Specifies how many times bigger than the maximum data value the maximum axis value must be before a warning is reported to a user.
 void setRepeatWarnings(boolean repeat)
          Specifies if warnings should be displayed every time applyAfterCheck() method is called even if the values have not changed in the panel.

 

Methods inherited from class oracle.dss.graph.gui.BaseAxis
getApplicationName, getColorPalette, getErrorHandler, getErrorTypes, getMinimumSize, getPreferredSize, setApplicationName, setErrorHandler, setErrorTypes, setLocale

 

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.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_AXIS_MAX_VALUE

public static final java.lang.String PROPERTY_AXIS_MAX_VALUE
Property: Axis Max Value. Use this constant when listening for changes in the option that specifies the maximum value that is displayed on the axis. To apply this change, the apply method of this panel sets the AxisMaxValue property of the data axis.
See Also:
BaseDataAxis.setAxisMaxValue(double)

PROPERTY_AXIS_MIN_VALUE

public static final java.lang.String PROPERTY_AXIS_MIN_VALUE
Property: Axis Min Value. Use this constant when listening for changes in the option that specifies the minumum value that is displayed on the axis. To apply this change, the apply method of this panel sets the AxisMinValue property of the data axis.
See Also:
BaseDataAxis.setAxisMinValue(double)

PROPERTY_AXIS_MAJOR_TICK_STEP

public static final java.lang.String PROPERTY_AXIS_MAJOR_TICK_STEP
Property: Axis Major Tick Step. Use this constant when listening for changes in the option that specifies the interval of tick marks of on the specified axis. To apply this change, the apply method of this panel sets the MajorTickStep property of the data axis.
See Also:
BaseDataAxis.setMajorTickStep(double)

PROPERTY_AXIS_AUTO_MAX

public static final java.lang.String PROPERTY_AXIS_AUTO_MAX
Property: Axis Auto Max. Use this constant when listening for changes in the option that specifies whether the maximum value of the axis is calculated automatically or set manually. To apply this change, the apply method of this panel sets the AxisMaxAutoScaled property of the data axis.
See Also:
BaseDataAxis.setAxisMaxAutoScaled(boolean)

PROPERTY_AXIS_AUTO_MIN

public static final java.lang.String PROPERTY_AXIS_AUTO_MIN
Property: Axis Auto Min. Use this constant when listening for changes in the option that specifies whether the minimum value of the axis is calculated automatically or set manually. To apply this change, the apply method of this panel sets the AxisMinAutoScaled property of the data axis.
See Also:
BaseDataAxis.setAxisMinAutoScaled(boolean)

PROPERTY_AXIS_AUTO_TICK_STEP

public static final java.lang.String PROPERTY_AXIS_AUTO_TICK_STEP
Property: Axis Auto Tick Step. Use this constant when listening for changes in the option that specifies whether the tick interval of the axis is calculated automatically or set manually. To apply this change, the apply method of this panel sets the <codeMajorTickStepAutomatic property of the data axis.
See Also:
BaseDataAxis.setMajorTickStepAutomatic(boolean)

PROPERTY_AXIS_LOG_SCALE

public static final java.lang.String PROPERTY_AXIS_LOG_SCALE
Property: Axis Log Scale. Use this constant when listening for changes in the option that specifies whether the axis uses a logarithmic scale or a linear scale. To apply this change, the apply method of this panel sets the ScaledLogarithmic property of the data axis.
See Also:
BaseDataAxis.setScaledLogarithmic(boolean)

PROPERTY_AXIS_LOG_BASE

public static final java.lang.String PROPERTY_AXIS_LOG_BASE
Property: Axis Logarithmic Base. Use this constant when listening for changes in the option that specifies the log base for an axis that uses a logarithmic scale. To apply this change, the apply method of this panel sets the LogarithmicBase property of the data axis.
See Also:
BaseDataAxis.setLogarithmicBase(double)
Constructor Detail

ValueAxis

public ValueAxis(UIGraph graph,
                 int componentID)
Constructor.
Parameters:
graph - The graph that this panel belongs to.
componentID - A constant that represents the axis that you want to be the value axis. The constants are listed in the See Also section.
See Also:
Graph.X1AXIS, Graph.Y1AXIS, Graph.Y2AXIS

ValueAxis

public ValueAxis(UIGraph graph,
                 int componentID,
                 int errorTypes)
Constructor.
Parameters:
graph - The graph that this panel belongs to.
componentID - A constant that represents the axis that you want this panel to work with. The constants are listed in the See Also section. The valid constants for this parameter end in "AXIS".
errorTypes - A constant that specifies the level of errors and warnings to display to the end user. The default value is ALL_ERRORS_AND_WARNINGS. The valid values are listed in the See Also section. You can use the OR operator (|) to combine settings.
See Also:
BaseAxis.ALL_ERRORS_AND_WARNINGS, BaseAxis.ALL_ERRORS, BaseAxis.WARNINGS, BaseAxis.NONE, BaseAxis.NON_DATA_ERRORS, Graph.X1AXIS, Graph.Y1AXIS, Graph.Y2AXIS
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 BaseAxis
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 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().
Overrides:
setColorPalette in class BaseAxis
Parameters:
colors - two dimesional array of Colors

setRepeatWarnings

public void setRepeatWarnings(boolean repeat)
Specifies if warnings should be displayed every time applyAfterCheck() method is called even if the values have not changed in the panel. The default value of the property is true.
Parameters:
repeat - true repeat displaying the warning message even if the values have not changed false do not display the warning message if the values have not changed.

isRepeatWarnings

public boolean isRepeatWarnings()
Indicates if warnings should be displayed every time applyAfterCheck() method is called even if the values have not changed in the panel.
Returns:
true if warning messages should be displayed even if the values have not changed in the panel. false otherwise.

apply

public void apply()
Deprecated. As of 2.4.0.4, replaced by applyAfterCheck()
Applies to the graph the changes that have been made in this panel. Normally, you call this method in the listener for the container's OK button.
Overrides:
apply in class BasePanel

applyAfterCheck

public boolean applyAfterCheck()
Applies changes that were made in this panel, but only if they are valid. This method checks the input that the user has given to this panel. If the input is valid, then this method applies the changes to the associated graph. If the input is not valid, then this method does not apply the changes. An example of an invalid change is a maximum axis value set to a value lower than the minimum axis value.

Normally, you call this method in the listener for the container's OK button.

Returns:
true if the changes were applied, false if the changes were not valid.

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.

setHelpProvider

public void setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider)
Sets the Help provider for this panel.

getHelpProvider

public oracle.bali.ewt.help.HelpProvider getHelpProvider()
Gets the Help provider for this panel.

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, this panel has an Axis Title Font button that displays a Font dialog box. The Font dialog box displays a Help button by default. Setting the parameter value of this method to false would hide that Help button.

Returns:
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, this panel has an Axis Title Font button that displays a Font dialog box. The Font dialog box displays a Help button by default. If the return value of this method is false, then that Help button is hidden.

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

setMaxMultiplier

public void setMaxMultiplier(int multiplier)
Specifies how many times bigger than the maximum data value the maximum axis value must be before a warning is reported to a user. This method sets the number by which the maximum value in the data is multiplied to determine the value of the axis maximum for which a user should be warned.

When the maximum value of the data is much smaller than the specified maximum value of the axis, then much of the plot area is empty, and the differences between data values are minimized, to the point of a distortion in the perception of the graph data. This method lets you determine how "much smaller" is defined.

By default, when a user sets the maximum value of an axis to 10 times the maximum value of the data that will appear in the graph, this panel reports a warning. If you want to warn users for smaller settings of the axis maximum, then call this method to set a lower multiple value, such as 3 or 4.

Warnings appear only if the setting of the ErrorType property includes warnings.

Parameters:
multiplier - The number by which to multiply the maximum value in the data, to find the warning level for the setting of the axis maximum.
See Also:
BaseAxis.setErrorTypes(int)

getMaxMultiplier

public int getMaxMultiplier()
Retrives the number by which the maximum data value is multiplied, to determine the setting of the axis maximum for which this panel reports a warning to end users.

Warnings appear only if the setting of the ErrorType property includes warnings.

Returns:
The number by which the highest value in the data is multiplied. Then the axis is set to the result of this multiplication or to a higher value, then this panel reports a warning to the user.
See Also:
BaseAxis.setErrorTypes(int)

cleanUp

public void cleanUp()
Clean up memory and resources of value axis panel
Overrides:
cleanUp in class BaseAxis
Overview  Package   Class  Tree  Deprecated  Index  Help 

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

 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2003, Oracle. All Rights Reserved.