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


oracle.dss.graph.gui
Class Title

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.graph.gui.BasePanel
                                |
                                +--oracle.dss.graph.gui.Title
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 Title
extends BasePanel
implements java.awt.event.ActionListener, java.awt.event.ItemListener, java.beans.PropertyChangeListener, javax.swing.event.CaretListener, HelpContext

Defines the Title panel. The Title panel is used to specify text and font properties for the title, subtitle, and footnote of a graph.

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_FOOTNOTE_TEXT
          Property: Footnote Text.
static java.lang.String PROPERTY_FOOTNOTE_VISIBLE
          Property: Footnote Visible.
static java.lang.String PROPERTY_SUBTITLE_TEXT
          Property: Subtitle Text.
static java.lang.String PROPERTY_SUBTITLE_VISIBLE
          Property: Subtitle Visible.
static java.lang.String PROPERTY_TITLE_TEXT
          Property: Title Text.
static java.lang.String PROPERTY_TITLE_VISIBLE
          Property: Title Visible.

 

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
Title(UIGraph graphView)
          Constructor.

 

Method Summary
 void apply()
          Applies to the graph, the changes that have been made to this panel.
 void cleanUp()
          Cleanup memory and resources used by title panel
 java.awt.Color[][] getColorPalette()
          Retreives the grid of colors used by font color choosers.
 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 Title panel.
 java.awt.Dimension getPreferredSize()
          Retrieves the size at which the Title panel looks best.
 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 font color choosers.
 void setGraph(UIGraph graphView)
          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)
          The Locale for this object.

 

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

 

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

 

Field Detail

PROPERTY_TITLE_VISIBLE

public static final java.lang.String PROPERTY_TITLE_VISIBLE
Property: Title Visible. Use this constant when listening for changes in the option that specifies whether the title appears in the graph. To apply this change, the apply method of this panel sets the Visible property of the GraphTitle object.
See Also:
BaseTitle.setVisible(boolean)

PROPERTY_SUBTITLE_VISIBLE

public static final java.lang.String PROPERTY_SUBTITLE_VISIBLE
Property: Subtitle Visible. Use this constant when listening for changes in the option that specifies whether the subtitle appears in the graph. To apply this change, the apply method of this panel sets the Visible property of the GraphSubtitle object.
See Also:
BaseTitle.setVisible(boolean)

PROPERTY_FOOTNOTE_VISIBLE

public static final java.lang.String PROPERTY_FOOTNOTE_VISIBLE
Property: Footnote Visible. Use this constant when listening for changes in the option that specifies whether the footnote appears in the graph. To apply this change, the apply method of this panel sets the Visible property of the GraphFootnote object.
See Also:
BaseTitle.setVisible(boolean)

PROPERTY_TITLE_TEXT

public static final java.lang.String PROPERTY_TITLE_TEXT
Property: Title Text. Use this constant when listening for changes in the option that specifies the text of the title. To apply this change, the apply method of this panel sets the Text property of the GraphTitle object.
See Also:
BaseTitle.setText(java.lang.String)

PROPERTY_SUBTITLE_TEXT

public static final java.lang.String PROPERTY_SUBTITLE_TEXT
Property: Subtitle Text. Use this constant when listening for changes in the option that specifies the text of the subtitle. To apply this change, the apply method of this panel sets the Text property of the GraphSubtitle object.
See Also:
BaseTitle.setText(java.lang.String)

PROPERTY_FOOTNOTE_TEXT

public static final java.lang.String PROPERTY_FOOTNOTE_TEXT
Property: Footnote Text. Use this constant when listening for changes in the option that specifies the text of the footnote. To apply this change, the apply method of this panel sets the Text property of the GraphFootnote object.
See Also:
BaseTitle.setText(java.lang.String)
Constructor Detail

Title

public Title(UIGraph graphView)
Constructor.
Parameters:
graphView - The graph that this panel belongs to.
Method Detail

setGraph

public void setGraph(UIGraph graphView)
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 font 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.
Parameters:
colors - two dimesional array of Colors

getColorPalette

public java.awt.Color[][] getColorPalette()
Retreives the grid of colors used by font color choosers.
Returns:
the two dimesional array of Colors

cleanUp

public void cleanUp()
Cleanup memory and resources used by title panel
Overrides:
cleanUp in class BasePanel

setLocale

public void setLocale(java.util.Locale loc)
The Locale for this object.
Overrides:
setLocale in class java.awt.Component
Parameters:
loc - The Locale for this object.

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 Title 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 Title panel.

getMinimumSize

public java.awt.Dimension getMinimumSize()
Retrieves the minimum size of the Title 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.

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 the Plot Area panel.

getHelpProvider

public oracle.bali.ewt.help.HelpProvider getHelpProvider()
Gets the Help provider for the Plot Area 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 Font buttons that each display 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 Font buttons that each display 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.

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


Copyright © 2003, Oracle. All Rights Reserved.