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


oracle.dss.gridView.gui
Class NumberFormatPanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.gridView.gui.NumberFormatPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, javax.swing.event.ChangeListener, java.util.EventListener, HelpContext, java.awt.image.ImageObserver, java.awt.event.ItemListener, javax.swing.event.ListSelectionListener, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable

public class NumberFormatPanel
extends javax.swing.JPanel
implements java.awt.event.ItemListener, java.beans.PropertyChangeListener, java.awt.event.ActionListener, javax.swing.event.ChangeListener, javax.swing.event.ListSelectionListener, HelpContext

Defines the gridView NumberFormatGeneral panel. End-users use the gridView NumberFormatGeneral panel to set number format 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 int NUMBER_FORMAT_TYPE_CURRENCY
          Constant for number format type
static int NUMBER_FORMAT_TYPE_CUSTOM
          Constant for number format type
static int NUMBER_FORMAT_TYPE_DEFAULT
          Constant for number format type
static int NUMBER_FORMAT_TYPE_NONE
          Constant for number format type
static int NUMBER_FORMAT_TYPE_NUMBER
          Constant for number format type
static int NUMBER_FORMAT_TYPE_PERCENT
          Constant for number format type
static java.lang.String PROPERTY_CURRENCY_SYMBOL_USED
          Property: CurrencySymbolUsed.
static java.lang.String PROPERTY_CUSTOM_TYPE_CHANGE
          Property: Custom Type Change.
static java.lang.String PROPERTY_DECIMAL_PLACES
          Property: Decimal Places.
static java.lang.String PROPERTY_DOLLAR_SIGN
          Property: DollarSign.
static java.lang.String PROPERTY_NEGATIVE_FORMAT
          Property: NegativeFormat.
static java.lang.String PROPERTY_NEGATIVENUMBER_TYPE_CHANGE
          Property: Negative Number Type Change.
static java.lang.String PROPERTY_POSITIVE_FORMAT
          Property: PositiveFormat.
static java.lang.String PROPERTY_SCALE
          Property: Scale.
static java.lang.String PROPERTY_SCALE_FACTOR
          Property: ScaleFactor.
static java.lang.String PROPERTY_SCALE_SIGN
          Property: ScaleSign.
static java.lang.String PROPERTY_THOUSAND_SEPARATOR
          Property: thousand separator.
static java.lang.String PROPERTY_TYPE_CHANGE
          Property: Type Change.

 

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
NumberFormatPanel(ViewFormat viewFormat)
          Constructor.

 

Method Summary
 void addCustomPatternString(java.lang.String pattern)
          Add pattern string to custom list
 void addDollarSign(java.lang.String sign)
          Add new currency sign
 ViewFormat apply()
          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.lang.String getCurrentCustomPatternString()
          retrieve custom pattern string
 int getDecimalPlaces()
          get decimal place
 java.lang.String getDefaultFormat()
          Application developer can use this method to retrive default format DefaultFormat's default value is "L999G999G999"
 java.lang.String getDollarSign()
          Retrieve current selected currency sign
 ErrorHandler getErrorHandler()
          Retrieves the error handler that this NumberFormatPanel uses.
 int getFormatType()
          get current selected format type
 java.lang.String getHelpContextID()
          Retrieves the Help context ID for this panel.
 java.awt.Dimension getMinimumSize()
          Retrieves the minimum size of the Plot Area panel.
 int getNegativeFormat()
          Retrieve negative format index
 java.awt.Dimension getPreferredSize()
          Retrieves the size at which the Plot Area panel looks best.
 int getScaleFactor()
          retrieve scale Factor
 ViewFormat getViewFormat()
          Retrieve viewFormat associated with this panel
 boolean isHelpEnabled()
          Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
 boolean isNegativeRed()
          Retrieve is current selection in negative list is a negative red number
 boolean isScale()
          Retrieve if scale is set
 boolean isShowCurrencySymbol()
          retrieve if CurrencySymbol is showed
 boolean isShowScaleMark()
          Retrieve if ShowScaleMark is set
 boolean isShowThousandSeparator()
          retrieve if Thousand Separator is showed
 void removeDollarSign(java.lang.String sign)
          Remove currency sign
 void setApplicationName(java.lang.String name)
          Specifies the name of application that uses this panel.
 void setCurrentCustomPatternString(java.lang.String pattern)
          specify selcted pattern string
 void setCustomPatternStringList(java.util.Vector patternVector)
          Specify pattern string vector
 void setDecimalPlaces(int value)
          set decimal place
 void setDefaultFormat(java.lang.String format)
          Application developer can use this method to set default format DefaultFormat's default value is "L999G999G999"
 void setDollarSign(java.lang.String dollarSign)
          Set urrent selected currency sign
 void setErrorHandler(ErrorHandler eh)
          Specifies an error handler for this NumberFormatPanel.
 void setFormatType(int formatType)
          set current selected format type
 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)
          Specifies the current Locale that the gridView uses.
 void setScale(boolean scale)
          Set Scale or not
 void setScaleFactor(int factor)
          Set ScaleFactor
 void setShowCurrencySymbol(boolean show)
          set CurrencySymbol showed
 void setShowScaleMark(boolean show)
          Set showing ScaleMark or not
 void setShowThousandSeparator(boolean show)
          set Thousand Separator showed
 void setViewFormat(ViewFormat viewFormat)
          Set viewFormat associated with this panel

 

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 java.awt.event.ActionListener
actionPerformed

 

Methods inherited from interface javax.swing.event.ChangeListener
stateChanged

 

Methods inherited from interface javax.swing.event.ListSelectionListener
valueChanged

 

Field Detail

PROPERTY_TYPE_CHANGE

public static final java.lang.String PROPERTY_TYPE_CHANGE
Property: Type Change.

PROPERTY_NEGATIVENUMBER_TYPE_CHANGE

public static final java.lang.String PROPERTY_NEGATIVENUMBER_TYPE_CHANGE
Property: Negative Number Type Change.

PROPERTY_CUSTOM_TYPE_CHANGE

public static final java.lang.String PROPERTY_CUSTOM_TYPE_CHANGE
Property: Custom Type Change.

PROPERTY_DECIMAL_PLACES

public static final java.lang.String PROPERTY_DECIMAL_PLACES
Property: Decimal Places.

PROPERTY_THOUSAND_SEPARATOR

public static final java.lang.String PROPERTY_THOUSAND_SEPARATOR
Property: thousand separator.

PROPERTY_SCALE

public static final java.lang.String PROPERTY_SCALE
Property: Scale.

PROPERTY_SCALE_FACTOR

public static final java.lang.String PROPERTY_SCALE_FACTOR
Property: ScaleFactor.

PROPERTY_SCALE_SIGN

public static final java.lang.String PROPERTY_SCALE_SIGN
Property: ScaleSign.

PROPERTY_NEGATIVE_FORMAT

public static final java.lang.String PROPERTY_NEGATIVE_FORMAT
Property: NegativeFormat.

PROPERTY_DOLLAR_SIGN

public static final java.lang.String PROPERTY_DOLLAR_SIGN
Property: DollarSign.

PROPERTY_POSITIVE_FORMAT

public static final java.lang.String PROPERTY_POSITIVE_FORMAT
Property: PositiveFormat.

PROPERTY_CURRENCY_SYMBOL_USED

public static final java.lang.String PROPERTY_CURRENCY_SYMBOL_USED
Property: CurrencySymbolUsed.

NUMBER_FORMAT_TYPE_NONE

public static final int NUMBER_FORMAT_TYPE_NONE
Constant for number format type

NUMBER_FORMAT_TYPE_DEFAULT

public static final int NUMBER_FORMAT_TYPE_DEFAULT
Constant for number format type

NUMBER_FORMAT_TYPE_NUMBER

public static final int NUMBER_FORMAT_TYPE_NUMBER
Constant for number format type

NUMBER_FORMAT_TYPE_CURRENCY

public static final int NUMBER_FORMAT_TYPE_CURRENCY
Constant for number format type

NUMBER_FORMAT_TYPE_PERCENT

public static final int NUMBER_FORMAT_TYPE_PERCENT
Constant for number format type

NUMBER_FORMAT_TYPE_CUSTOM

public static final int NUMBER_FORMAT_TYPE_CUSTOM
Constant for number format type
Constructor Detail

NumberFormatPanel

public NumberFormatPanel(ViewFormat viewFormat)
Constructor.
Method Detail

setErrorHandler

public void setErrorHandler(ErrorHandler eh)
Specifies an error handler for this NumberFormatPanel. If an error handler has been set, then this NumberFormatPanel 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 NumberFormatPanel 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.

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.

apply

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

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.

addCustomPatternString

public void addCustomPatternString(java.lang.String pattern)
Add pattern string to custom list
Parameters:
pattern - pattern string

setCurrentCustomPatternString

public void setCurrentCustomPatternString(java.lang.String pattern)
specify selcted pattern string
Parameters:
pattern - Selected pattern string

setCustomPatternStringList

public void setCustomPatternStringList(java.util.Vector patternVector)
Specify pattern string vector
Parameters:
patternVector - pattern vector

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.

setDefaultFormat

public void setDefaultFormat(java.lang.String format)
Application developer can use this method to set default format DefaultFormat's default value is "L999G999G999"

getDefaultFormat

public java.lang.String getDefaultFormat()
Application developer can use this method to retrive default format DefaultFormat's default value is "L999G999G999"

getFormatType

public int getFormatType()
get current selected format type
Returns:
current selected format type

setFormatType

public void setFormatType(int formatType)
set current selected format type
Parameters:
formatType - current selected format type

getDecimalPlaces

public int getDecimalPlaces()
get decimal place
Returns:
decimal place

setDecimalPlaces

public void setDecimalPlaces(int value)
set decimal place
Parameters:
value - decimal place

isShowThousandSeparator

public boolean isShowThousandSeparator()
retrieve if Thousand Separator is showed
Returns:
if Thousand Separator is showed

setShowThousandSeparator

public void setShowThousandSeparator(boolean show)
set Thousand Separator showed
Parameters:
show -  

isShowCurrencySymbol

public boolean isShowCurrencySymbol()
retrieve if CurrencySymbol is showed
Returns:
if CurrencySymbol is showed

setShowCurrencySymbol

public void setShowCurrencySymbol(boolean show)
set CurrencySymbol showed
Parameters:
show -  

addDollarSign

public void addDollarSign(java.lang.String sign)
Add new currency sign
Parameters:
sign - new currency sign

removeDollarSign

public void removeDollarSign(java.lang.String sign)
Remove currency sign
Parameters:
sign -  

getDollarSign

public java.lang.String getDollarSign()
Retrieve current selected currency sign
Returns:
selected currency sign

setDollarSign

public void setDollarSign(java.lang.String dollarSign)
Set urrent selected currency sign
Parameters:
dollarSign - selected currency sign

isScale

public boolean isScale()
Retrieve if scale is set
Returns:
boolean

setScale

public void setScale(boolean scale)
Set Scale or not
Parameters:
scale -  

setScaleFactor

public void setScaleFactor(int factor)
Set ScaleFactor
Parameters:
factor -  

isShowScaleMark

public boolean isShowScaleMark()
Retrieve if ShowScaleMark is set
Returns:
boolean

setShowScaleMark

public void setShowScaleMark(boolean show)
Set showing ScaleMark or not
Parameters:
show -  

getViewFormat

public ViewFormat getViewFormat()
Retrieve viewFormat associated with this panel
Returns:
viewFormat

setViewFormat

public void setViewFormat(ViewFormat viewFormat)
Set viewFormat associated with this panel
Parameters:
viewFormat -  

getScaleFactor

public int getScaleFactor()
retrieve scale Factor
Returns:
int scale Factor

getNegativeFormat

public int getNegativeFormat()
Retrieve negative format index
Returns:
int negative format index

isNegativeRed

public boolean isNegativeRed()
Retrieve is current selection in negative list is a negative red number
Returns:
boolean

getCurrentCustomPatternString

public java.lang.String getCurrentCustomPatternString()
retrieve custom pattern string
Returns:
string

cleanUp

public void cleanUp()
Clean up memory and space

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


Copyright © 2003, Oracle. All Rights Reserved.