oracle.dss.gridView.gui
Class FormatsPanel

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CrosstabFormatsPanel, TableFormatsPanel

public abstract class FormatsPanel

extends javax.swing.JPanel

implements java.awt.event.ItemListener, java.beans.PropertyChangeListener, javax.swing.event.ListDataListener, java.awt.event.ActionListener, HelpContext

Defines the gridView Formats panel. End-users use the gridView Formats panel to new/edit/delete/add/save formats 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

DEFAULT_FORMAT_CHANGED

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

FormatsPanel(UIGridView gridView)
Constructor.

Method Summary

void	addDatabodyDefaultFormat(java.lang.String label, DiscriminatorRule rule, int numberOrData) Add new default format for databody
void	addFilterElement(java.lang.String name, int index) Add new filter element to filters list
void	addHeaderDefaultFormat(java.lang.String label, DiscriminatorRule rule) Add new default format for header
void	addUIFormat(UIFormat uiFormat, int index) Add new format
boolean	apply() Applies to the gridView the changes that have been made to this panel.
boolean	apply(UIGridView gridView) Applies to the gridView the changes that have been made to this panel.
void	cleanUp() Clean up memory space
java.lang.String	getApplicationName() Retrieves the name of the application that uses this panel.
CustomObjectManager	getCustomObjectManager()
java.lang.String	getDefaultDateFormatString() Get default number format string from DateFormatPanel
java.lang.String	getDefaultNumberFormatString() Get default number format string from NumberFormatPanel
ErrorHandler	getErrorHandler() Retrieves the error handler that this FormatFormats uses.
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 Plot Area panel.
java.awt.Dimension	getPreferredSize() Retrieves the size at which the Plot Area panel looks best.
int	getUIFormatCountInGroup(int group) Get number of UIFormats in the specific group
UIFormatNameCallBack	getUIFormatNameCallBack() Retrive formatNameCallBack
boolean	isHelpEnabled() Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
boolean	isUIFormatSelected(int group, int index) Get UIFormat selected or not
void	removeAllUIFormats() Remove all UIFormat
void	removeFilterElement(java.lang.String name) Remove filter element from filters list by name
void	removeFilterElementAt(int index) Remove filter element from filters list by index
void	removeUIFormat(int group, int index) Remove UIFormat
void	setApplicationName(java.lang.String name) Specifies the name of application that uses this panel.
void	setCustomObjectManager(CustomObjectManager customObjectManager) Set Custom Object Manager
void	setDefaultDateFormatString(java.lang.String dateFormat) Set default number format string on NumberFormat Panel
void	setDefaultNumberFormatString(java.lang.String numberFormat) Set default number format string on NumberFormatPanel
void	setErrorHandler(ErrorHandler eh) Specifies an error handler for this FormatFormats.
void	setGridView(UIGridView gridView)
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) Specifies the current Locale that the gridView uses.
void	setUIFormatNameCallBack(UIFormatNameCallBack formatNameCallBack) Specify formatNameCallBack
void	setUIFormatSelected(int group, int index, boolean selected) Set UIFormat selected or not

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

Methods inherited from interface javax.swing.event.ListDataListener

contentsChanged, intervalAdded, intervalRemoved

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Field Detail

DEFAULT_FORMAT_CHANGED

public static final java.lang.String DEFAULT_FORMAT_CHANGED

Constructor Detail

FormatsPanel

public FormatsPanel(UIGridView gridView)

Constructor.

Parameters:

gridView - The UIGridView to which this object belongs.

Method Detail

setGridView

public void setGridView(UIGridView gridView)

Parameters:

gridView - The UIGridView to which this object belongs.

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Specifies an error handler for this FormatFormats. If an error handler has been set, then this FormatFormats 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 FormatFormats uses.

Returns:

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

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.

addHeaderDefaultFormat

public void addHeaderDefaultFormat(java.lang.String label,
DiscriminatorRule rule)

Add new default format for header

Parameters:

label - format name

rule - discriminatorRule in this format

addDatabodyDefaultFormat

public void addDatabodyDefaultFormat(java.lang.String label,
DiscriminatorRule rule,
                                     int numberOrData)

Add new default format for databody

Parameters:

label - format name

rule - discriminatorRule in this format

addUIFormat

public void addUIFormat(UIFormat uiFormat,
                        int index)

Add new format

Parameters:

UIFormat -

removeUIFormat

public void removeUIFormat(int group,
                           int index)

Remove UIFormat

Parameters:

group - group number

index - index number in the group

removeAllUIFormats

public void removeAllUIFormats()

Remove all UIFormat

getUIFormatCountInGroup

public int getUIFormatCountInGroup(int group)

Get number of UIFormats in the specific group

Parameters:

group - group number

setUIFormatSelected

public void setUIFormatSelected(int group,
                                int index,
                                boolean selected)

Set UIFormat selected or not

Parameters:

group - group number

index - index number in the specific group

selected - selected or not

isUIFormatSelected

public boolean isUIFormatSelected(int group,
                                  int index)

Get UIFormat selected or not

Parameters:

group - group number

index - index number in the specific group

setUIFormatNameCallBack

public void setUIFormatNameCallBack(UIFormatNameCallBack formatNameCallBack)

Specify formatNameCallBack

Parameters:

formatNameCallBack -

getUIFormatNameCallBack

public UIFormatNameCallBack getUIFormatNameCallBack()

Retrive formatNameCallBack

Returns:

formatNameCallBack

addFilterElement

public void addFilterElement(java.lang.String name,
                             int index)

Add new filter element to filters list

Parameters:

name - the filter name

index - index position where this filter will be insert to

removeFilterElement

public void removeFilterElement(java.lang.String name)

Remove filter element from filters list by name

Parameters:

name - the filter name

removeFilterElementAt

public void removeFilterElementAt(int index)

Remove filter element from filters list by index

Parameters:

index - the filter index

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

Parameters:

strHelpContextID - help context ID string

setHelpProvider

public void setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider)

Sets the Help provider for this panel.

Parameters:

helpProvider - help provider

getHelpProvider

public oracle.bali.ewt.help.HelpProvider getHelpProvider()

Gets the Help provider for this panel.

Returns:

HelpProvider help provider

apply

public boolean apply()

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.

apply

public boolean apply(UIGridView gridView)

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.

Parameters:

gridView - UIGridView which FormatsPanel apply to

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.

getCustomObjectManager

public CustomObjectManager getCustomObjectManager()

setCustomObjectManager

public void setCustomObjectManager(CustomObjectManager customObjectManager)

Set Custom Object Manager

Parameters:

customObjectManager - Custom Object Manager

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.

setDefaultNumberFormatString

public void setDefaultNumberFormatString(java.lang.String numberFormat)

Set default number format string on NumberFormatPanel

Parameters:

numberFormat - number format string

getDefaultNumberFormatString

public java.lang.String getDefaultNumberFormatString()

Get default number format string from NumberFormatPanel

Returns:

default number format string used on NumberFormatPanel

setDefaultDateFormatString

public void setDefaultDateFormatString(java.lang.String dateFormat)

Set default number format string on NumberFormat Panel

Parameters:

numberFormat - number format string

getDefaultDateFormatString

public java.lang.String getDefaultDateFormatString()

Get default number format string from DateFormatPanel

Returns:

default number format string used on DateFormatPanel

cleanUp

public void cleanUp()

Clean up memory space