com.monkeycoder.monkeynes.gui
Class StateLight

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--com.monkeycoder.monkeynes.gui.StateLight

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class StateLight

extends JComponent

This is a graphics component representing a boolean value as a light.

Originally part of the MonkeyNES project.

Author:

David Stephens

See Also:

Serialized Form

Field Summary

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 java.awt.image.ImageObserver

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

Constructor Summary

StateLight(boolean inState, Color inTrueColor, Color inFalseColor)
Creates a new StateLight using the specified colors for true and false, and in the specified state.

StateLight(boolean inState, Color inTrueColor, Color inTrueBorderColor, Color inFalseColor, Color inFalseBorderColor)
Creates a new StateLight using the specified colors and border colors for true and false, and in the specified state.

StateLight(Color inTrueColor, Color inFalseColor)
Creates a new StateLight using the specified colors for true and false.

StateLight(Color inTrueColor, Color inTrueBorderColor, Color inFalseColor, Color inFalseBorderColor)
Creates a new StateLight using the specified colors and border colors for true and false.

Method Summary

Dimension	getPreferredSize() Returns the size this light prefers to be the parent drawing component.
boolean	getState() Gets the current state of the light.
void	paint(Graphics g) Paints the surface of this component based on the current state and colors.
void	setState(boolean inState) Sets the current state of the light.

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, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

Constructor Detail

StateLight

public StateLight(Color inTrueColor,
                  Color inFalseColor)

Creates a new StateLight using the specified colors for true and false.

Parameters:

inTrueColor - The color to use when the light is representing true.

inFalseColor - The color to use when the light is representing false.

StateLight

public StateLight(boolean inState,
                  Color inTrueColor,
                  Color inFalseColor)

Creates a new StateLight using the specified colors for true and false, and in the specified state.

Parameters:

inState - The state this light is in upon creation.

inTrueColor - The color to use when the light is representing true.

inFalseColor - The color to use when the light is representing false.

StateLight

public StateLight(Color inTrueColor,
                  Color inTrueBorderColor,
                  Color inFalseColor,
                  Color inFalseBorderColor)

Creates a new StateLight using the specified colors and border colors for true and false.

Parameters:

inTrueColor - The color to use when the light is representing true.

inTrueBorderColor - The border color to use when the light is representing true.

inFalseColor - The color to use when the light is representing false.

inFalseBorderColor - The border color to use when the light is representing false.

StateLight

public StateLight(boolean inState,
                  Color inTrueColor,
                  Color inTrueBorderColor,
                  Color inFalseColor,
                  Color inFalseBorderColor)

Creates a new StateLight using the specified colors and border colors for true and false, and in the specified state.

Parameters:

inState - The state this light is in upon creation.

inTrueColor - The color to use when the light is representing true.

inTrueBorderColor - The border color to use when the light is representing true.

inFalseColor - The color to use when the light is representing false.

inFalseBorderColor - The border color to use when the light is representing false.

Method Detail

getState

public boolean getState()

Gets the current state of the light.

Returns:

The current state of the light.

setState

public void setState(boolean inState)

Sets the current state of the light.

Parameters:

inState - The current state of the light.

getPreferredSize

public Dimension getPreferredSize()

Returns the size this light prefers to be the parent drawing component.

Overrides:

getPreferredSize in class JComponent

Returns:

The size this light prefers to be.

paint

public void paint(Graphics g)

Paints the surface of this component based on the current state and colors.

Overrides:

paint in class JComponent

Parameters:

g - The graphics component that will be used for drawing this component.