JSettlers v1.0.6 API
Built ${date}

soc.client
Class ColorSquare

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Canvas
          extended bysoc.client.ColorSquare
All Implemented Interfaces:
javax.accessibility.Accessible, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.event.MouseListener, java.io.Serializable

public class ColorSquare
extends java.awt.Canvas
implements java.awt.event.MouseListener

This is a square box with a background color and possibly a number or X in it. This box can be interactive, or non-interactive. The possible colors of the box correspond to resources in SoC.

Author:
Robert S Thomas
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.awt.Canvas
java.awt.Canvas.AccessibleAWTCanvas
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static int BOUNDED_DEC
           
static int BOUNDED_INC
           
static int CHECKBOX
           
static java.awt.Color CLAY
           
static java.awt.Color GREY
           
static int HEIGHT
           
static int NUMBER
           
static java.awt.Color ORE
           
static java.awt.Color SHEEP
           
static java.awt.Color WHEAT
           
static int WIDTH
           
static java.awt.Color WOOD
           
static int YES_NO
           
 
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, PROPERTIES, SOMEBITS
 
Constructor Summary
ColorSquare()
          Creates a new ColorSquare object without a visible value.
ColorSquare(java.awt.Color c)
          Creates a new ColorSquare object with specified background color.
ColorSquare(java.awt.Color c, int v)
          Creates a new ColorSquare object with specified background color and initial value.
ColorSquare(int k, boolean in, java.awt.Color c)
          Creates a new ColorSquare of the specified kind and background color.
ColorSquare(int k, boolean in, java.awt.Color c, int upper, int lower)
          Creates a new ColorSquare of the specified kind and background color.
 
Method Summary
 void addValue(int v)
          DOCUMENT ME!
 boolean getBoolValue()
          DOCUMENT ME!
 int getIntValue()
          DOCUMENT ME!
 java.awt.Dimension getMinimumSize()
          DOCUMENT ME!
 java.awt.Dimension getPreferedSize()
          DOCUMENT ME!
 void mouseClicked(java.awt.event.MouseEvent e)
          DOCUMENT ME!
 void mouseEntered(java.awt.event.MouseEvent e)
          DOCUMENT ME!
 void mouseExited(java.awt.event.MouseEvent e)
          DOCUMENT ME!
 void mousePressed(java.awt.event.MouseEvent evt)
          DOCUMENT ME!
 void mouseReleased(java.awt.event.MouseEvent e)
          DOCUMENT ME!
 void paint(java.awt.Graphics g)
          DOCUMENT ME!
 void setBoolValue(boolean v)
          DOCUMENT ME!
 void setColor(java.awt.Color c)
          DOCUMENT ME!
 void setIntValue(int v)
          DOCUMENT ME!
 void subtractValue(int v)
          DOCUMENT ME!
 
Methods inherited from class java.awt.Canvas
addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, 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, 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, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, 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, processEvent, 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, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, 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

CLAY

public static final java.awt.Color CLAY

ORE

public static final java.awt.Color ORE

SHEEP

public static final java.awt.Color SHEEP

WHEAT

public static final java.awt.Color WHEAT

WOOD

public static final java.awt.Color WOOD

GREY

public static final java.awt.Color GREY

NUMBER

public static final int NUMBER
See Also:
Constant Field Values

YES_NO

public static final int YES_NO
See Also:
Constant Field Values

CHECKBOX

public static final int CHECKBOX
See Also:
Constant Field Values

BOUNDED_INC

public static final int BOUNDED_INC
See Also:
Constant Field Values

BOUNDED_DEC

public static final int BOUNDED_DEC
See Also:
Constant Field Values

WIDTH

public static final int WIDTH
See Also:
Constant Field Values

HEIGHT

public static final int HEIGHT
See Also:
Constant Field Values
Constructor Detail

ColorSquare

public ColorSquare()
Creates a new ColorSquare object without a visible value.

See Also:
ColorSquare(int, boolean, Color, int, int)

ColorSquare

public ColorSquare(java.awt.Color c)
Creates a new ColorSquare object with specified background color. Type NUMBER, non-interactive, upper=99, lower=0.

Parameters:
c - background color
See Also:
ColorSquare(int, boolean, Color, int, int)

ColorSquare

public ColorSquare(java.awt.Color c,
                   int v)
Creates a new ColorSquare object with specified background color and initial value. Type NUMBER, non-interactive, upper=99, lower=0.

Parameters:
c - background color
v - initial int value
See Also:
ColorSquare(int, boolean, Color, int, int)

ColorSquare

public ColorSquare(int k,
                   boolean in,
                   java.awt.Color c)
Creates a new ColorSquare of the specified kind and background color. Possibly interactive. For kind = NUMBER, upper=99, lower=0.

Parameters:
k - Kind: NUMBER, YES_NO, CHECKBOX, BOUNDED_INC, BOUNDED_DECk
in - interactive flag allowing user interaction
c - background color
See Also:
ColorSquare(int, boolean, Color, int, int)

ColorSquare

public ColorSquare(int k,
                   boolean in,
                   java.awt.Color c,
                   int upper,
                   int lower)
Creates a new ColorSquare of the specified kind and background color. Possibly interactive, with upper and lower bounds specified for NUMBER kinds.

Parameters:
k - Kind: NUMBER, YES_NO, CHECKBOX, BOUNDED_INC, BOUNDED_DECk
in - interactive flag allowing user interaction
c - background color
upper - upper bound if k == NUMBER
lower - lower bound if k == NUMBER
Method Detail

setColor

public void setColor(java.awt.Color c)
DOCUMENT ME!

Parameters:
c - DOCUMENT ME!

getPreferedSize

public java.awt.Dimension getPreferedSize()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getMinimumSize

public java.awt.Dimension getMinimumSize()
DOCUMENT ME!

Returns:
DOCUMENT ME!

paint

public void paint(java.awt.Graphics g)
DOCUMENT ME!

Parameters:
g - DOCUMENT ME!

addValue

public void addValue(int v)
DOCUMENT ME!

Parameters:
v - DOCUMENT ME!

subtractValue

public void subtractValue(int v)
DOCUMENT ME!

Parameters:
v - DOCUMENT ME!

setIntValue

public void setIntValue(int v)
DOCUMENT ME!

Parameters:
v - DOCUMENT ME!

getIntValue

public int getIntValue()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setBoolValue

public void setBoolValue(boolean v)
DOCUMENT ME!

Parameters:
v - DOCUMENT ME!

getBoolValue

public boolean getBoolValue()
DOCUMENT ME!

Returns:
DOCUMENT ME!

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)
DOCUMENT ME!

Specified by:
mouseEntered in interface java.awt.event.MouseListener
Parameters:
e - DOCUMENT ME!

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)
DOCUMENT ME!

Specified by:
mouseExited in interface java.awt.event.MouseListener
Parameters:
e - DOCUMENT ME!

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)
DOCUMENT ME!

Specified by:
mouseClicked in interface java.awt.event.MouseListener
Parameters:
e - DOCUMENT ME!

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)
DOCUMENT ME!

Specified by:
mouseReleased in interface java.awt.event.MouseListener
Parameters:
e - DOCUMENT ME!

mousePressed

public void mousePressed(java.awt.event.MouseEvent evt)
DOCUMENT ME!

Specified by:
mousePressed in interface java.awt.event.MouseListener
Parameters:
evt - DOCUMENT ME!

JSettlers v1.0.6 API
Built ${date}