TallButton (Core com.ccg Classes 1.1.6-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ccg.awt
Class TallButton

java.lang.Object
  java.awt.Component
      com.ccg.awt.TallButton

All Implemented Interfaces:: ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:: ImageButton

public class TallButton
extends Component
extends Component

A lightweight three state button that can be set quite tall. This is a lightweight component which implements a three state button. The three visual states include:

The normal unpressed state of a button.
The highlight state of a button (when the user's mouse enters the components area).
The "pressed" in look of the button.

You use this object in a fashion similar to a Button (in the future it may be more similar to a JButton object). You can register yourself to listen for events as you normally would. To customize this object, use the following methods:

setForeground: This method controls the color of the text on the button when it has not yet been pressed (similar to a Button).
setBackground: This method controls the color of the button when it has not been pressed (similar to a Button).
setButtonPressedColor(java.awt.Color): This method controls the color of the button when it has been pressed in (it defaults to dark gray).
setTextPressedColor(java.awt.Color): This method controls the color of the text when the button is depressed (its default value is null - which will cause it to use the same value as the foreground color).
setTextEchoOn(boolean): Set this boolean value to true if you want the text label on the button to be drawn twice when the mouse enters the buttons area (in a different color typically to create a etched look).
setTextEchoColor(java.awt.Color): If this is set to a non-null value, then the text will be drawn on the button twice (first with this color and slightly shifted). If you set this to black or white, it can create an "etched" look for the text when the user's mouse enters the area.
setButtonHeight(int): Sets how tall the button will be drawn. This corresponds to the number of lines of beveled edges that will be drawn.
setMargin(int): Sets how many pixels of space are desired around the text which is displayed on the button.
setSemiPush(int): Sets how far the button should appear to "push" when the user's mouse enters the text area.

This class should be updated to allow button pressing via the keyboard (not sure at the moment if this is done by looking for ActionEvent or direct KeyEvent events.

Since:: 1.0
Version:: $Revision: 1.11 $
Author:: $Author: pkb $
See Also:: TallButtonDemo.java, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Component
`Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy`

Field Summary
`static int`	`AROUND_TEXT` Constant defining one of the `focus modes` supported.
`static int`	`INSIDE` Constant defining one of the `focus modes` supported.
`static int`	`NONE` Constant defining one of the `focus modes` supported.
`static int`	`OUTSIDE` Constant defining one of the `focus modes` supported.
`static int`	`UNDERLINE_TEXT` Constant defining one of the `focus modes` supported.

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
`TallButton()` Initializes object to a default state.
`TallButton(String text, int height, int SemiPush, int margin, Color echoColor)` Construct and initialize the object.

Method Summary
`void`	`addActionListener(ActionListener l)` Register to receive button press notification.
`Align`	`getAlign()` Get the `Align` object used to align the bounding box of the text
`int`	`getButtonHeight()` Get the height of the button.
`Color`	`getButtonPressedColor()` Get button color when the button is pressed
`Color`	`getDisabledButtonColor()` Get the color to use for buttons when the button is disabled.
`Color`	`getDisabledTextColor()` Get the color to use for text labels when the button is disabled.
`Color`	`getFocusColor()` Get the color to use to show button has focus.
`int`	`getFocusMode()` Get how the button should be "emphasized" when it has focus.
`static String[]`	`getFocusModeChoices()` Get the default list of Strings used to specify focus modes.
`Insets`	`getInsets()` Get how much the component should be inset from edges.
`int`	`getMargin()` Get the amount of desired margin space around the text the button.
`Color`	`getMouseOverColor()` Get the `color` of the button when the mouse pointer is over it
`MultiLineText`	`getMultiLineText()` Get the `MultiLineText` object which has the text
`Dimension`	`getPreferredSize()` Computes the preferred size of the button.
`int`	`getSemiPush()` Get the semi depress value of the button.
`String`	`getText()` Get the text label which appears on the button.
`Color`	`getTextEchoColor()` Get the color used when echoing text to show user what button they are on.
`Color`	`getTextEchoReleasedColor()` Get the color used when echoing text on a button in a released state.
`Color`	`getTextPressedColor()` Get the color of the text when the button is pressed.
`boolean`	`isEmphasized()` Should the button be emphasized (is the mouse over it)?
`boolean`	`isFocusTraversable()` Indicate that component can be traversed using keyboard.
`boolean`	`isPressed()` Is the button currently "pressed" (being held down).
`boolean`	`isTextEchoOn()` Is text echoed (hightlighted) when button has focus?
`void`	`paint(Graphics g)` Paints the component on a `graphics context`.
`void`	`paintInsets(Graphics g)` Paints the "inset" border on a `graphics context`.
`void`	`paintText(Graphics g)` Paints the text component on a `graphics context`.
`void`	`processEvent(AWTEvent e)` Monitor for certain MOUSE/KEYBOARD events.
`void`	`removeActionListener(ActionListener l)` Deregister to receive button press notification.
`void`	`set(TagLookup info)` Set properties for button based on values in `TagLookup` table.
`void`	`setAlign(Align val)` Set the `Align` object used to align the bounding box of the text
`void`	`setButtonHeight(int h)` Set the height of the button.
`void`	`setButtonPressedColor(Color val)` Set button color when the button is pressed
`void`	`setEnabled(boolean state)` Set whether the button should be enabled or disabled.
`void`	`setFocusColor(Color val)` Set the color to use to show button has focus.
`void`	`setFocusMode(int val)` Set how the button should be "emphasized" when it has focus.
`void`	`setInsets(Insets val)` Set how much the component should be inset from edges This property controls how much clear area should exist at the edges of the component.
`void`	`setMargin(int margin)` Set the amount of margin space around text on top of the button.
`void`	`setMouseOverColor(Color val)` Set the `color` of the button when the mouse pointer is over it You can set this value to 'null' to force the mouse over color to match the "released" state of the button.
`void`	`setMultiLineText(MultiLineText val)` Set the `MultiLineText` object which has the text
`void`	`setSemiPush(int v)` Set the semi depressed value of the button.
`void`	`setText(String text)` Set the text label which appears on the button.
`void`	`setTextEchoColor(Color c)` Set the "echo" `color` when button has the focus.
`void`	`setTextEchoOn(boolean val)` Set text echoed (hightlighted) when button has focus.
`void`	`setTextEchoReleasedColor(Color c)` Set the "echo" `color` when button is released.
`void`	`setTextPressedColor(Color c)` Set the color of the text when the button is pressed.
`void`	`update(Graphics g)` Disable clearing of component area.

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail