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


oracle.dss.graph.gui
Class GroupAxis

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.GroupAxis
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, javax.swing.event.CaretListener, javax.swing.event.ChangeListener, java.util.EventListener, HelpContext, java.awt.image.ImageObserver, java.awt.event.ItemListener, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable

public class GroupAxis
extends BaseAxis
implements javax.swing.event.ChangeListener, HelpContext

Defines the Group Axis panel. The Group Axis panel is used to specify options for the group axis on your graph. The group axis is the ordinal axis of a graph. Specifically, it is the O1Axis. An ordinal axis usually represents a dimension, and has dimension members along it, such as January 2000, February 2000, and so on.

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

See Also:
PROPERTY_TICKLABEL_SKIPCOUNT, PROPERTY_TICKLABEL_SKIPFIRST, PROPERTY_TICKLABEL_SKIPMODE, O1Axis, Serialized Form

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

 

Field Summary
static java.lang.String PROPERTY_TICKLABEL_SKIPCOUNT
          Property: Tick Label Skip Count.
static java.lang.String PROPERTY_TICKLABEL_SKIPFIRST
          Property: Tick Label Skip First.
static java.lang.String PROPERTY_TICKLABEL_SKIPMODE
          Property: Tick Label Skip Mode.

 

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
GroupAxis(UIGraph graph)
          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 memory and resources of GroupAxis 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.
 java.awt.Dimension getPreferredSize()
          New gets the preferred size of the panel
 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 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.

 

Methods inherited from class oracle.dss.graph.gui.BaseAxis
getApplicationName, getColorPalette, getErrorHandler, getErrorTypes, getMinimumSize, 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 javax.swing.event.ChangeListener
stateChanged

 

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_TICKLABEL_SKIPMODE

public static final java.lang.String PROPERTY_TICKLABEL_SKIPMODE
Property: Tick Label Skip Mode. Use this constant when listening for changes in the option that specifies whether the graph calculates tick label skipping. To apply this change, the apply method of this panel sets the TickLabelSkipMode property of the O1TickLabel object.
See Also:
O1TickLabel.setTickLabelSkipMode(int)

PROPERTY_TICKLABEL_SKIPFIRST

public static final java.lang.String PROPERTY_TICKLABEL_SKIPFIRST
Property: Tick Label Skip First. Use this constant when listening for changes in the option that sets the first tick label to display. To apply this change, the apply method of this panel sets the TickLabelSkipFirst property of the O1TickLabel object.
See Also:
O1TickLabel.setTickLabelSkipFirst(int)

PROPERTY_TICKLABEL_SKIPCOUNT

public static final java.lang.String PROPERTY_TICKLABEL_SKIPCOUNT
Property: Tick Label Skip Count. Use this constant when listening for changes in the option that sets the number of tick labels to skip. To apply this change, the apply method of this panel sets the TickLabelSkipCount property of the O1TickLabel object.
See Also:
O1TickLabel.setTickLabelSkipCount(int)
Constructor Detail

GroupAxis

public GroupAxis(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 BaseAxis
Parameters:
graph - The graph whose properties this panel sets.

cleanUp

public void cleanUp()
Clean memory and resources of GroupAxis panel
Overrides:
cleanUp in class BaseAxis

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

getPreferredSize

public java.awt.Dimension getPreferredSize()
New gets the preferred size of the panel
Overrides:
getPreferredSize in class BaseAxis
Returns:
instance of Dimension representing the preferred size

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

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, this panel has a 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 would be hidden.

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

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


Copyright © 2003, Oracle. All Rights Reserved.