x10.awt
Class UnitPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Panel
              x10.awt.UnitPanel

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, UnitListener

Direct Known Subclasses:

ApplianceUnitPanel, ApplicationUnitPanel, LightUnitPanel, MasterUnitPanel

public abstract class UnitPanel

extends java.awt.Panel

implements UnitListener

UnitPanel is the superclass extended by all awt x10 virtual unit panels. This class provides all of the common functionality between different awt unit panels.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.awt.Panel

java.awt.Panel.AccessibleAWTPanel

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

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

Field Summary

protected java.lang.String

address address String - the X10 device address associated with this panel.

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

UnitPanel(Controller controller, java.lang.String address)
UnitPanel constructs the UnitPanel shell and registers with the controller, and associates the X10 device address.

Method Summary

void	addCommand(Command command) addCommand is a convienience method for posting a command from the subclassed UnitPanel to the controller.
void	allLightsOff(UnitEvent event) allLightsOff is called when an x10 All Lights Off event occurs.
void	allLightsOn(UnitEvent event) allLightsOn is called when an x10 All Lights On event occurs.
void	allUnitsOff(UnitEvent event) allUnitsOff is called when an x10 All Units Off event occurs.
abstract void	brighten(int percent) brighten should be implemented by the subclass to handle receiving a brighten command.
abstract void	dim(int percent) dim should be implemented by the subclass to handle receiving a dim command.
java.lang.String	getAddress() getAddress returns the X10 address of this virtual Unit.
Controller	getController() getController returns the x10.Controller that is responsible for controlling this virtual Unit.
abstract void	off() off should be implemented by the subclass to handle receiveing an off command.
abstract void	on() on should be implemented by the subclass to handle receiving an on command.
void	unitBright(UnitEvent event) unitBright is called when an x10 Bright event occurs.
void	unitDim(UnitEvent event) unitDim is called when an x10 Dim event occurs.
void	unitOff(UnitEvent event) unitOff is called when an x10 Off event occurs.
void	unitOn(UnitEvent event) unitOn is called when an x10 On event occurs.

Methods inherited from class java.awt.Panel

addNotify, getAccessibleContext

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, 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

address

protected java.lang.String address

address String - the X10 device address associated with this panel.

Constructor Detail

UnitPanel

public UnitPanel(Controller controller,
                 java.lang.String address)
          throws java.lang.IllegalArgumentException

UnitPanel constructs the UnitPanel shell and registers with the controller, and associates the X10 device address.

Parameters:

controller - the controller to attatch to

address - the device address associated with this panel

Throws:

java.lang.IllegalArgumentException - thrown if the address specified does not follow X10 address rules.

Method Detail

addCommand

public void addCommand(Command command)

addCommand is a convienience method for posting a command from the subclassed UnitPanel to the controller.

Parameters:

command - the command to be posted to the controller.

on

public abstract void on()

on should be implemented by the subclass to handle receiving an on command. This method will be called when any appropriate "on" event is received.

off

public abstract void off()

off should be implemented by the subclass to handle receiveing an off command. This method will be called when any appropriate "off" event is received.

dim

public abstract void dim(int percent)

dim should be implemented by the subclass to handle receiving a dim command. This method will be called when any appropriate "dim" event is received.

Parameters:

percent - - percentage to dim the module by

brighten

public abstract void brighten(int percent)

brighten should be implemented by the subclass to handle receiving a brighten command. This method will be called when any appropriate "brighten" event is received.

Parameters:

percent - - percentage to brighten the module by

allUnitsOff

public void allUnitsOff(UnitEvent event)

Description copied from interface: UnitListener

allUnitsOff is called when an x10 All Units Off event occurs.

Specified by:

allUnitsOff in interface UnitListener

Parameters:

event - the UnitEvent that is dispatched.

allLightsOff

public void allLightsOff(UnitEvent event)

Description copied from interface: UnitListener

allLightsOff is called when an x10 All Lights Off event occurs.

Specified by:

allLightsOff in interface UnitListener

Parameters:

event - the UnitEvent that is dispatched.

allLightsOn

public void allLightsOn(UnitEvent event)

Description copied from interface: UnitListener

allLightsOn is called when an x10 All Lights On event occurs.

Specified by:

allLightsOn in interface UnitListener

Parameters:

event - the UnitEvent that is dispatched.

unitOn

public void unitOn(UnitEvent event)

Description copied from interface: UnitListener

unitOn is called when an x10 On event occurs.

Specified by:

unitOn in interface UnitListener

Parameters:

event - the UnitEvent that is dispatched.

unitOff

public void unitOff(UnitEvent event)

Description copied from interface: UnitListener

unitOff is called when an x10 Off event occurs.

Specified by:

unitOff in interface UnitListener

Parameters:

event - the UnitEvent that is dispatched.

unitDim

public void unitDim(UnitEvent event)

Description copied from interface: UnitListener

unitDim is called when an x10 Dim event occurs.

Specified by:

unitDim in interface UnitListener

Parameters:

event - the UnitEvent that is dispatched.

unitBright

public void unitBright(UnitEvent event)

Description copied from interface: UnitListener

unitBright is called when an x10 Bright event occurs.

Specified by:

unitBright in interface UnitListener

Parameters:

event - the UnitEvent that is dispatched.

getController

public Controller getController()

getController returns the x10.Controller that is responsible for controlling this virtual Unit.

Returns:

Controller the Controller that is responsible for controlling the unit associated with this panel.

getAddress

public java.lang.String getAddress()

getAddress returns the X10 address of this virtual Unit. (A1 - P16)

Returns:

String the X10 address of the unit associated with this panel.