oracle.dss.gridView.gui
Class DatePanel

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

All Implemented Interfaces:

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

public class DatePanel

extends javax.swing.JPanel

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

Panel used for Date Formatting.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static int	CATEGORIES_OFFSET_CUSTOM
static int	CATEGORIES_OFFSET_DATE
static int	CATEGORIES_OFFSET_DATETIME
static int	CATEGORIES_OFFSET_DEFAULT
static int	CATEGORIES_OFFSET_NONE
static int	CATEGORIES_OFFSET_TIME
static java.lang.String	PROPERTY_DATEPANEL_DATEFORMATCHANGED

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

DatePanel(ViewFormat viewFormat)
Default constructor.

DatePanel(ViewFormat viewFormat, java.util.Vector customListVector)
Alternate constructor.

DatePanel(ViewFormat viewFormat, java.util.Vector customListVector, java.lang.String strDefaultDateFormat)
Alternate constructor.

Method Summary

void	addElementToCustomList(java.lang.String strElement) add one element to the Customized list
boolean	apply() Applies date format string to the 'ViewFormat'
void	cleanUp() Clean up memory and space
java.lang.String	getApplicationName() Retrieves the name of the application that uses this panel.
int	getCategoryType() get the Category type: CATEGORIES_OFFSET_NONE CATEGORIES_OFFSET_DEFAULT CATEGORIES_OFFSET_DATE CATEGORIES_OFFSET_TIME CATEGORIES_OFFSET_DATETIME CATEGORIES_OFFSET_CUSTOM
java.util.Vector	getCustomList() get the Customized list
java.lang.String	getDefaultDateFormatString() Get the default date format string returns The default date format string.
ErrorHandler	getErrorHandler() Retrieves the error handler that this DatePanel uses.
java.lang.String	getHelpContextID() Retrieves the Help context ID for this panel.
ViewFormat	getViewFormat() get the ViewFormat
boolean	isHelpEnabled() Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
void	setApplicationName(java.lang.String name) Specifies the name of application that uses this panel.
void	setCategoryType(int iType) set the Category type to one of the following: CATEGORIES_OFFSET_NONE CATEGORIES_OFFSET_DEFAULT CATEGORIES_OFFSET_DATE CATEGORIES_OFFSET_TIME CATEGORIES_OFFSET_DATETIME CATEGORIES_OFFSET_CUSTOM
void	setCustomList(java.util.Vector strListVector) set the Customized list
void	setDefaultDateFormatString(java.lang.String strFormat) Set the default date format string
void	setErrorHandler(ErrorHandler eh) Specifies an error handler for this DatePanel.
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	setLocale(java.util.Locale loc) set locale of the font

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, getMinimumSize, getNextFocusableComponent, getPreferredSize, 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.beans.PropertyChangeListener

propertyChange

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Methods inherited from interface javax.swing.event.ListSelectionListener

valueChanged

Field Detail

PROPERTY_DATEPANEL_DATEFORMATCHANGED

public static final java.lang.String PROPERTY_DATEPANEL_DATEFORMATCHANGED

CATEGORIES_OFFSET_NONE

public static final int CATEGORIES_OFFSET_NONE

CATEGORIES_OFFSET_DEFAULT

public static final int CATEGORIES_OFFSET_DEFAULT

CATEGORIES_OFFSET_DATE

public static final int CATEGORIES_OFFSET_DATE

CATEGORIES_OFFSET_TIME

public static final int CATEGORIES_OFFSET_TIME

CATEGORIES_OFFSET_DATETIME

public static final int CATEGORIES_OFFSET_DATETIME

CATEGORIES_OFFSET_CUSTOM

public static final int CATEGORIES_OFFSET_CUSTOM

Constructor Detail

DatePanel

public DatePanel(ViewFormat viewFormat)

Default constructor.

DatePanel

public DatePanel(ViewFormat viewFormat,
                 java.util.Vector customListVector)

Alternate constructor. Takes a 'customListVector' param which will initialize the JList for the 'Custom' Panel.

DatePanel

public DatePanel(ViewFormat viewFormat,
                 java.util.Vector customListVector,
                 java.lang.String strDefaultDateFormat)

Alternate constructor. Takes a 'customListVector' param which will initialize the JList for the 'Custom' Panel. Also takes a 'strDefaultDateFormat' param for initializing the default date format string.

Method Detail

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

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

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.

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.

setDefaultDateFormatString

public void setDefaultDateFormatString(java.lang.String strFormat)

Set the default date format string

Parameters:

strFormat - The default date format string.

getDefaultDateFormatString

public java.lang.String getDefaultDateFormatString()

Get the default date format string returns The default date format string.

apply

public boolean apply()

Applies date format string to the 'ViewFormat'

setLocale

public void setLocale(java.util.Locale loc)

set locale of the font

Overrides:

setLocale in class java.awt.Component

getViewFormat

public ViewFormat getViewFormat()

get the ViewFormat

setCustomList

public void setCustomList(java.util.Vector strListVector)

set the Customized list

getCustomList

public java.util.Vector getCustomList()

get the Customized list

addElementToCustomList

public void addElementToCustomList(java.lang.String strElement)

add one element to the Customized list

getCategoryType

public int getCategoryType()

get the Category type: CATEGORIES_OFFSET_NONE CATEGORIES_OFFSET_DEFAULT CATEGORIES_OFFSET_DATE CATEGORIES_OFFSET_TIME CATEGORIES_OFFSET_DATETIME CATEGORIES_OFFSET_CUSTOM

setCategoryType

public void setCategoryType(int iType)

set the Category type to one of the following: CATEGORIES_OFFSET_NONE CATEGORIES_OFFSET_DEFAULT CATEGORIES_OFFSET_DATE CATEGORIES_OFFSET_TIME CATEGORIES_OFFSET_DATETIME CATEGORIES_OFFSET_CUSTOM

cleanUp

public void cleanUp()

Clean up memory and space