oracle.dss.gridView.gui
Class FormatGeneralPanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.gridView.gui.FormatGeneralPanel

All Implemented Interfaces:

javax.accessibility.Accessible, java.util.EventListener, HelpContext, java.awt.image.ImageObserver, java.awt.event.ItemListener, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable

public class FormatGeneralPanel

extends javax.swing.JPanel

implements java.awt.event.ItemListener, java.beans.PropertyChangeListener, HelpContext

Defines the gridView FormatGeneral panel. End-users use the gridView FormatFormatGeneral panel to set format general attributes of table or crosstab

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_BACKGROUND_COLOR Property: Background Color
static java.lang.String	PROPERTY_BOTTOM_LINE_COLOR Property: Bottom Line Color.
static java.lang.String	PROPERTY_BOTTOM_LINE_WIDTH Property: Bottom Line Width.
static java.lang.String	PROPERTY_DATA_BARS_COLOR Property: Data Bars Color.
static java.lang.String	PROPERTY_DATA_BARS_VISIBLE Property: Data Bars Visible.
static java.lang.String	PROPERTY_LEFT_LINE_COLOR Property: Left Line Color.
static java.lang.String	PROPERTY_LEFT_LINE_WIDTH Property: Left Line Width.
static java.lang.String	PROPERTY_OUTLINE_COLOR Property: Outline Color.
static java.lang.String	PROPERTY_OUTLINE_WIDTH Property: Outline Width.
static java.lang.String	PROPERTY_RIGHT_LINE_COLOR Property: Right Line Color.
static java.lang.String	PROPERTY_RIGHT_LINE_WIDTH Property: Right Line Width.
static java.lang.String	PROPERTY_TOP_LINE_COLOR Property: Top Line Color.
static java.lang.String	PROPERTY_TOP_LINE_WIDTH Property: Top Line Width.

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

FormatGeneralPanel(ViewStyle gridViewStyle)
Constructor.

Method Summary

boolean	apply(ViewStyle gridViewStyle) Applies to the gridView the changes that have been made to this panel.
void	cleanUp() Clean up memory and space
java.lang.String	getApplicationName() Retrieves the name of the application that uses this panel.
java.awt.Color	getBackgroundColor() retrive current BackgroundColor
java.awt.Color	getBottomColor() retrive current BottomColor
int	getBottomStyle() retrive current BottomlineStyle
int	getBottomWidth() retrive current BottomWidth
java.awt.Color	getDataBarColor() retrive current DataBarColor
ErrorHandler	getErrorHandler() Retrieves the error handler that this FormatFormatGeneral uses.
java.lang.String	getFormatName() retrive current format name
java.lang.String	getHelpContextID() Retrieves the Help context ID for this panel.
java.awt.Color	getLeftColor() retrive current LeftColor
int	getLeftStyle() retrive current LeftlineStyle
int	getLeftWidth() retrive current LeftWidth
java.awt.Dimension	getMinimumSize() Retrieves the minimum size of the Plot Area panel.
java.awt.Color	getOutlineColor() retrive current OutlineColor
int	getOutlineStyle() retrive current OutlineStyle
int	getOutlineWidth() retrive current OutlineWidth
java.awt.Dimension	getPreferredSize() Retrieves the size at which the Plot Area panel looks best.
java.awt.Color	getRightColor() retrive current RightColor
int	getRightStyle() retrive current RightStyle
int	getRightWidth() retrive current RightWidth
java.awt.Color	getTopColor() retrive current TopColor
int	getTopStyle() retrive current ToplineStyle
int	getTopWidth() retrive current TopWidth
boolean	isHelpEnabled() Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
boolean	isShowDataBar() retrive current ShowDataBar
void	setApplicationName(java.lang.String name) Specifies the name of application that uses this panel.
void	setBackgroundColor(java.awt.Color color) Specifies the current BackgroundColor.
void	setBottomColor(java.awt.Color color) Specifies the current BottomColor.
void	setBottomStyle(int style) Specifies the current BottomlineStyle.
void	setBottomWidth(int width) Specifies the current BottomWidth.
void	setDataBarColor(java.awt.Color color) Specifies the current DataBarColor.
void	setErrorHandler(ErrorHandler eh) Specifies an error handler for this FormatFormatGeneral.
void	setFormatName(java.lang.String name) Specifies the current Formatname.
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	setLeftColor(java.awt.Color color) Specifies the current LeftColor.
void	setLeftStyle(int style) Specifies the current LeftlineStyle.
void	setLeftWidth(int width) Specifies the current LeftWidth.
void	setLocale(java.util.Locale loc) Specifies the current Locale that the gridView uses.
void	setOutlineColor(java.awt.Color color) Specifies the current OutlineColor.
void	setOutlineStyle(int style) Specifies the current OutlineStyle.
void	setOutlineWidth(int width) Specifies the current OutlineWidth.
void	setRightColor(java.awt.Color color) Specifies the current RightColor.
void	setRightStyle(int style) Specifies the current RightlineStyle.
void	setRightWidth(int width) Specifies the current RightWidth.
void	setShowDataBar(boolean trueOrFalse) Specifies the current ShowDataBar.
void	setTopColor(java.awt.Color color) Specifies the current TopColor.
void	setTopStyle(int style) Specifies the current ToplineStyle.
void	setTopWidth(int width) Specifies the current TopWidth.

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

itemStateChanged

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Field Detail

PROPERTY_BACKGROUND_COLOR

public static final java.lang.String PROPERTY_BACKGROUND_COLOR

Property: Background Color

PROPERTY_DATA_BARS_VISIBLE

public static final java.lang.String PROPERTY_DATA_BARS_VISIBLE

Property: Data Bars Visible. Use this constant when listening for changes in the option that specifies whether Data Bars appear. To apply this change, the apply method of this panel sets the Visible property of the object that represents Data Bars.

PROPERTY_DATA_BARS_COLOR

public static final java.lang.String PROPERTY_DATA_BARS_COLOR

Property: Data Bars Color. Use this constant when listening for changes in the option that specifies the color of Data Bars. To apply this change, the apply method of this panel sets the Color property of the object that represents Data Bars.

PROPERTY_OUTLINE_WIDTH

public static final java.lang.String PROPERTY_OUTLINE_WIDTH

Property: Outline Width. Use this constant when listening for changes in the option that specifies the width of Outline. To apply this change, the apply method of this panel sets the LineWidth property of the object that represents hOutline.

PROPERTY_OUTLINE_COLOR

public static final java.lang.String PROPERTY_OUTLINE_COLOR

Property: Outline Color. Use this constant when listening for changes in the option that specifies the color of Outline To apply this change, the apply method of this panel sets the LineColor property of the object that represents Outline.

PROPERTY_LEFT_LINE_WIDTH

public static final java.lang.String PROPERTY_LEFT_LINE_WIDTH

Property: Left Line Width. Use this constant when listening for changes in the option that specifies the width of Left lines. To apply this change, the apply method of this panel sets the LineWidth property of the object that represents Left lines.

PROPERTY_LEFT_LINE_COLOR

public static final java.lang.String PROPERTY_LEFT_LINE_COLOR

Property: Left Line Color. Use this constant when listening for changes in the option that specifies the color of Left Line To apply this change, the apply method of this panel sets the LineColor property of the object that represents Left Line.

PROPERTY_TOP_LINE_WIDTH

public static final java.lang.String PROPERTY_TOP_LINE_WIDTH

Property: Top Line Width. Use this constant when listening for changes in the option that specifies the width of Top lines. To apply this change, the apply method of this panel sets the LineWidth property of the object that represents Top lines.

PROPERTY_TOP_LINE_COLOR

public static final java.lang.String PROPERTY_TOP_LINE_COLOR

Property: Top Line Color. Use this constant when listening for changes in the option that specifies the color of Top Line To apply this change, the apply method of this panel sets the LineColor property of the object that represents Top Line.

PROPERTY_RIGHT_LINE_WIDTH

public static final java.lang.String PROPERTY_RIGHT_LINE_WIDTH

Property: Right Line Width. Use this constant when listening for changes in the option that specifies the width of Right lines. To apply this change, the apply method of this panel sets the LineWidth property of the object that represents Right lines.

PROPERTY_RIGHT_LINE_COLOR

public static final java.lang.String PROPERTY_RIGHT_LINE_COLOR

Property: Right Line Color. Use this constant when listening for changes in the option that specifies the color of Right Line To apply this change, the apply method of this panel sets the LineColor property of the object that represents Right Line.

PROPERTY_BOTTOM_LINE_WIDTH

public static final java.lang.String PROPERTY_BOTTOM_LINE_WIDTH

Property: Bottom Line Width. Use this constant when listening for changes in the option that specifies the width of Bottom lines. To apply this change, the apply method of this panel sets the LineWidth property of the object that represents Bottom lines.

PROPERTY_BOTTOM_LINE_COLOR

public static final java.lang.String PROPERTY_BOTTOM_LINE_COLOR

Property: Bottom Line Color. Use this constant when listening for changes in the option that specifies the color of Bottom Line To apply this change, the apply method of this panel sets the LineColor property of the object that represents Bottom Line.

Constructor Detail

FormatGeneralPanel

public FormatGeneralPanel(ViewStyle gridViewStyle)

Constructor.

Parameters:

gridView - The GridView to which this object belongs.

Method Detail

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Specifies an error handler for this FormatFormatGeneral. If an error handler has been set, then this FormatFormatGeneral reports error conditions to the handler. Otherwise, it prints the stack trace.

Parameters:

eh - The error handler that this panel should use.

getErrorHandler

public ErrorHandler getErrorHandler()

Retrieves the error handler that this FormatFormatGeneral uses.

Returns:

The error handler for this panel, or null if no error handler has been set.

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.

setLocale

public void setLocale(java.util.Locale loc)

Specifies the current Locale that the gridView uses.

Overrides:

setLocale in class java.awt.Component

Parameters:

loc - The current Locale.

setFormatName

public void setFormatName(java.lang.String name)

Specifies the current Formatname.

Parameters:

name - The current Format name.

getFormatName

public java.lang.String getFormatName()

retrive current format name

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

Specifies the current BackgroundColor.

Parameters:

color - The current BackgroundColor.

getBackgroundColor

public java.awt.Color getBackgroundColor()

retrive current BackgroundColor

setDataBarColor

public void setDataBarColor(java.awt.Color color)

Specifies the current DataBarColor.

Parameters:

color - The current DataBarColor.

getDataBarColor

public java.awt.Color getDataBarColor()

retrive current DataBarColor

setShowDataBar

public void setShowDataBar(boolean trueOrFalse)

Specifies the current ShowDataBar.

Parameters:

trueOrFalse - The current ShowDataBar.

isShowDataBar

public boolean isShowDataBar()

retrive current ShowDataBar

setOutlineWidth

public void setOutlineWidth(int width)

Specifies the current OutlineWidth.

Parameters:

width - The current OutlineWidth.

getOutlineWidth

public int getOutlineWidth()

retrive current OutlineWidth

setOutlineStyle

public void setOutlineStyle(int style)

Specifies the current OutlineStyle.

Parameters:

style - The current OutlineStyle.

getOutlineStyle

public int getOutlineStyle()

retrive current OutlineStyle

setOutlineColor

public void setOutlineColor(java.awt.Color color)

Specifies the current OutlineColor.

Parameters:

color - The current OutlineColor.

getOutlineColor

public java.awt.Color getOutlineColor()

retrive current OutlineColor

setTopWidth

public void setTopWidth(int width)

Specifies the current TopWidth.

Parameters:

width - The current TopWidth.

getTopWidth

public int getTopWidth()

retrive current TopWidth

setTopStyle

public void setTopStyle(int style)

Specifies the current ToplineStyle.

Parameters:

style - The current ToplineStyle.

getTopStyle

public int getTopStyle()

retrive current ToplineStyle

setLeftWidth

public void setLeftWidth(int width)

Specifies the current LeftWidth.

Parameters:

width - The current LeftWidth.

getLeftWidth

public int getLeftWidth()

retrive current LeftWidth

setLeftStyle

public void setLeftStyle(int style)

Specifies the current LeftlineStyle.

Parameters:

style - The current LeftlineStyle.

getLeftStyle

public int getLeftStyle()

retrive current LeftlineStyle

setBottomWidth

public void setBottomWidth(int width)

Specifies the current BottomWidth.

Parameters:

width - The current BottomWidth.

getBottomWidth

public int getBottomWidth()

retrive current BottomWidth

setBottomStyle

public void setBottomStyle(int style)

Specifies the current BottomlineStyle.

Parameters:

style - The current BottomlineStyle.

getBottomStyle

public int getBottomStyle()

retrive current BottomlineStyle

setRightWidth

public void setRightWidth(int width)

Specifies the current RightWidth.

Parameters:

width - The current RightWidth.

getRightWidth

public int getRightWidth()

retrive current RightWidth

setRightStyle

public void setRightStyle(int style)

Specifies the current RightlineStyle.

Parameters:

style - The current RightStyle.

getRightStyle

public int getRightStyle()

retrive current RightStyle

setTopColor

public void setTopColor(java.awt.Color color)

Specifies the current TopColor.

Parameters:

color - The current TopColor.

getTopColor

public java.awt.Color getTopColor()

retrive current TopColor

setLeftColor

public void setLeftColor(java.awt.Color color)

Specifies the current LeftColor.

Parameters:

color - The current LeftColor.

getLeftColor

public java.awt.Color getLeftColor()

retrive current LeftColor

setBottomColor

public void setBottomColor(java.awt.Color color)

Specifies the current BottomColor.

Parameters:

color - The current BottomColor.

getBottomColor

public java.awt.Color getBottomColor()

retrive current BottomColor

setRightColor

public void setRightColor(java.awt.Color color)

Specifies the current RightColor.

Parameters:

color - The current RightColor.

getRightColor

public java.awt.Color getRightColor()

retrive current RightColor

apply

public boolean apply(ViewStyle gridViewStyle)

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

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.

getMinimumSize

public java.awt.Dimension getMinimumSize()

Retrieves the minimum size of the Plot Area 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.

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, suppose that this panel had a font button and that font button displayed a font dialog box. If that font dialog box had a Help button, then this method would specify whether that Help button is displayed.

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, suppose that this panel had a font button and that font button displayed a font dialog box. If that font dialog box had a Help button, then this method would tell you whether that Help button is displayed.

Returns:

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

cleanUp

public void cleanUp()

Clean up memory and space