oracle.dss.dataView.gui
Class TitlePanel

oracle.dss.dataView.gui.TitlePanel

All Implemented Interfaces:

java.awt.event.ActionListener, javax.swing.event.CaretListener, java.util.EventListener, HelpContext, java.awt.event.ItemListener, java.beans.PropertyChangeListener

public class TitlePanel

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

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

See Also:

Serialized Form

Field Summary

static java.lang.String	DEFAULT_FORMAT_CHANGED
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.

Constructor Summary

TitlePanel(UIDataview dataview)
Constructor.

Method Summary

boolean	apply() Applies to the dataview, the changes that have been made to this panel.
void	cleanUp() Clean up memory space
java.awt.Color[][]	getColorPalette() Retreives the grid of colors used by title 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 this 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 title font color choosers.
void	setDataview(UIDataview dataview) Specifies the gridView 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	setLocale(java.util.Locale loc) The Locale for this object.

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 gridview. To apply this change, the apply method of this panel sets the Visible property of the GraphTitle object.

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 gridview. To apply this change, the apply method of this panel sets the Visible property of the GraphSubtitle object.

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 gridview. To apply this change, the apply method of this panel sets the Visible property of the GraphFootnote object.

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

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 Subtitle object.

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 ootnote object.

DEFAULT_FORMAT_CHANGED

public static final java.lang.String DEFAULT_FORMAT_CHANGED

Constructor Detail

TitlePanel

public TitlePanel(UIDataview dataview)

Constructor.

Parameters:

gridView - The gridview that this panel belongs to.

Method Detail

setDataview

public void setDataview(UIDataview dataview)

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

Parameters:

gridview - The gridview whose properties this panel sets.

setColorPalette

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

Specifies the grid of colors to use in color palettes of title 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 title font color choosers.

Returns:

the two dimesional array of Colors

cleanUp

public void cleanUp()

Clean up memory space

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 boolean apply()

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

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