Skip navigation links

com.essbase.eas.ui
Class CButton

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.AbstractButton
javax.swing.JButton
com.essbase.eas.ui.CButton

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants

Direct Known Subclasses:

ActivateButton, ApplyButton, BackButton, CancelButton, CloseButton, CTBarButton, DefaultButton, DoneButton, FinishButton, HelpButton, NextButton, OkButton, RefreshButton, ResetButton

public class CButton

extends javax.swing.JButton

Generic JButton

Title:

Description:

Copyright: Copyright (c) 2001

Company: Hyperion Solutions Corporation

Version:

1.0

Author:

Sree Menon

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JButton

javax.swing.JButton.AccessibleJButton

Nested classes/interfaces inherited from class javax.swing.AbstractButton

javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

javax.swing.AbstractAction	action
protected boolean	bCloseable
protected DefaultFocusHandler	focHandler
protected java.lang.String	method
protected java.lang.Object	owner the owner where the methods are directed.
protected boolean	stateChanged

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, 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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

CButton()
contructs a button

CButton(javax.swing.Icon icon)
Constructs a button with an icon(image)

CButton(java.lang.String caption)
contructs a button with the name

CButton(java.lang.String caption, java.lang.String methodName)
contructs a button with the name

CButton(java.lang.String caption, java.lang.String methodName, boolean closeable)

CButton(java.lang.String caption, java.lang.String methodName, javax.swing.KeyStroke key)

CButton(java.lang.String caption, java.lang.String methodName, javax.swing.KeyStroke key, boolean closeable)

CButton(java.lang.String caption, java.lang.String methodName, javax.swing.KeyStroke key, char mnemonic, boolean closeable)
the button text is set based on the text in resource file caption + "_Caption"<li/> the mnemonic is set based on the text in resource file caption + "_Mnemonic" <li/> the tooltip text is set based on the text in resource file caption + "_Tip" <li/>

CButton(java.lang.String caption, java.lang.String methodName, java.lang.Object owner)
contructs a button with the name

Method Summary

void	addKeyStroke(int condition, javax.swing.KeyStroke keyStroke) add a key stroke to the input map
void	addKeyStroke(javax.swing.KeyStroke keyStroke) add a key stroke to the input map, the keystroke is added as WHEN_IN_FOCUSED_WINDOW condition
void	dispose() disposes the button the action listener is removed the focus handler is removed (or disposed)
protected boolean	doAction()
void	focusListenerFor(java.awt.Component[] components) sets the focus listener for the components
protected javax.swing.plaf.ButtonUI	getPrimaryButtonUI()
void	handleEsapceKey() handles the ESC key to trigger action performed
boolean	isCloseable()
void	setAccessibleDescription(java.lang.String desc)
void	setAsDefaultButton() This will make the enter key to invoke the action listener on this.
void	setCloseable(boolean closeable) set the buttons closeable property on its parents
void	setEnabled(boolean enabled) Enables (or disables) the button.
protected void	setKeyStroke(javax.swing.KeyStroke key)
void	setMethodName(java.lang.String name) set the introspection method name
void	setOwner(java.lang.Object owner)

Methods inherited from class javax.swing.JButton

getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUI

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

method

protected java.lang.String method

bCloseable

protected boolean bCloseable

focHandler

protected DefaultFocusHandler focHandler

owner

protected java.lang.Object owner

the owner where the methods are directed. if the owner field is set, the method is invoked on the owner rather than walking the parent chain

stateChanged

protected boolean stateChanged

action

public javax.swing.AbstractAction action

Constructor Detail

CButton

public CButton()

contructs a button

CButton

public CButton(javax.swing.Icon icon)

Constructs a button with an icon(image)

Parameters:

icon - - icon image to display on the button

CButton

public CButton(java.lang.String caption)

contructs a button with the name

Parameters:

caption - the button text

CButton

public CButton(java.lang.String caption,
               java.lang.String methodName)

contructs a button with the name

Parameters:

caption - the button text

methodName - the method of parent to invoke

CButton

public CButton(java.lang.String caption,
               java.lang.String methodName,
               java.lang.Object owner)

contructs a button with the name

Parameters:

caption - the button text

methodName - the method of owner to invoke

owner - the owner of the button

CButton

public CButton(java.lang.String caption,
               java.lang.String methodName,
               javax.swing.KeyStroke key)

Parameters:

caption - the button text

methodName - the method of parent to invoke

key - the keystroke

CButton

public CButton(java.lang.String caption,
               java.lang.String methodName,
               javax.swing.KeyStroke key,
               boolean closeable)

Parameters:

caption - the button text

methodName - the method of parent to invoke

key - the keystroke

closeable - true if the action closes the parent dialog or internal frame

CButton

public CButton(java.lang.String caption,
               java.lang.String methodName,
               boolean closeable)

Parameters:

caption - the button text

methodName - the method of parent to invoke

closeable - true if the action closes the parent dialog or internal frame

CButton

public CButton(java.lang.String caption,
               java.lang.String methodName,
               javax.swing.KeyStroke key,
               char mnemonic,
               boolean closeable)

• the button text is set based on the text in resource file caption + "_Caption"<li/>
• the mnemonic is set based on the text in resource file caption + "_Mnemonic" <li/>
• the tooltip text is set based on the text in resource file caption + "_Tip" <li/>

  Parameters:

  caption - the button text

  methodName - the method of parent to invoke

  key - the keystroke

  mnemonic - button mnemonic. pass 0 if none

  closeable - true if the action closes the parent dialog or internal frame

Method Detail

setKeyStroke

protected void setKeyStroke(javax.swing.KeyStroke key)

doAction

protected boolean doAction()

focusListenerFor

public void focusListenerFor(java.awt.Component[] components)

sets the focus listener for the components

Parameters:

components - the components for which the button is the default button

setAsDefaultButton

public void setAsDefaultButton()

This will make the enter key to invoke the action listener on this.

addKeyStroke

public void addKeyStroke(javax.swing.KeyStroke keyStroke)

add a key stroke to the input map, the keystroke is added as WHEN_IN_FOCUSED_WINDOW condition

Parameters:

keyStroke - keystroke to add

addKeyStroke

public void addKeyStroke(int condition,
                         javax.swing.KeyStroke keyStroke)

add a key stroke to the input map

Parameters:

condition - condition can be WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

keyStroke - keystroke to add

setCloseable

public void setCloseable(boolean closeable)

set the buttons closeable property on its parents

Parameters:

closeable - true if the top dialog or the internal frame to be closed on the action listener

isCloseable

public boolean isCloseable()

Returns:

if the button has closeable property set

handleEsapceKey

public void handleEsapceKey()

handles the ESC key to trigger action performed

setMethodName

public void setMethodName(java.lang.String name)

set the introspection method name

Parameters:

name - name of the method

setOwner

public void setOwner(java.lang.Object owner)

Parameters:

owner - introspection object

setEnabled

public void setEnabled(boolean enabled)

Enables (or disables) the button.

Overrides:

setEnabled in class javax.swing.AbstractButton

Parameters:

b - true to enable the button, otherwise false

getPrimaryButtonUI

protected javax.swing.plaf.ButtonUI getPrimaryButtonUI()

setAccessibleDescription

public void setAccessibleDescription(java.lang.String desc)

dispose

public void dispose()

disposes the button the action listener is removed the focus handler is removed (or disposed)

Skip navigation links