x10.awt
Class ApplianceUnitPanel

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Panel
              extended byx10.awt.UnitPanel
                  extended byx10.awt.ApplianceUnitPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, UnitListener

public class ApplianceUnitPanel
extends UnitPanel
implements java.awt.event.ActionListener

ApplianceUnitPanel is an awt-based panel that can be used to control an X10 appliance module.

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
 
Fields inherited from class x10.awt.UnitPanel
address
 
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
ApplianceUnitPanel(Controller controller, java.lang.String address)
          ApplianceUnitPanel constructs a new awt-based panel for controling an X10 Appliance module.
ApplianceUnitPanel(Controller controller, java.lang.String address, java.lang.String title)
          ApplianceUnitPanel constructs a new awt-based panel for controling an X10 Appliance module.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent event)
          actionPerformed handles clicks on the On and Off buttons
 void allLightsOn(UnitEvent event)
          allLightsOn is called when an x10 All Lights On event occurs.
 void brighten(int percent)
          brighten should be implemented by the subclass to handle receiving a brighten command.
 void dim(int percent)
          dim should be implemented by the subclass to handle receiving a dim command.
 boolean getState()
          getState returns the current state of the associated module.
 java.lang.String getTitle()
          getTitle returns the title associated with this panel
 void off()
          off should be implemented by the subclass to handle receiveing an off command.
 void on()
          on should be implemented by the subclass to handle receiving an on command.
 void setTitle(java.lang.String title)
          setTitle sets the title that appears at the top of this panel
 
Methods inherited from class x10.awt.UnitPanel
addCommand, allLightsOff, allUnitsOff, getAddress, getController, unitBright, unitDim, unitOff, unitOn
 
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
 

Constructor Detail

ApplianceUnitPanel

public ApplianceUnitPanel(Controller controller,
                          java.lang.String address)
                   throws java.lang.IllegalArgumentException
ApplianceUnitPanel constructs a new awt-based panel for controling an X10 Appliance module.

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.

ApplianceUnitPanel

public ApplianceUnitPanel(Controller controller,
                          java.lang.String address,
                          java.lang.String title)
                   throws java.lang.IllegalArgumentException
ApplianceUnitPanel constructs a new awt-based panel for controling an X10 Appliance module.

Parameters:
controller - the controller to attatch to
address - the device address associated with this panel
title - the title to be displayed at the top of the panel
Throws:
java.lang.IllegalArgumentException - thrown if the address specified does not follow X10 address rules.
Method Detail

on

public void on()
Description copied from class: UnitPanel
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.

Specified by:
on in class UnitPanel

off

public void off()
Description copied from class: UnitPanel
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.

Specified by:
off in class UnitPanel

dim

public void dim(int percent)
Description copied from class: UnitPanel
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.

Specified by:
dim in class UnitPanel
Parameters:
percent - - percentage to dim the module by

brighten

public void brighten(int percent)
Description copied from class: UnitPanel
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.

Specified by:
brighten in class UnitPanel
Parameters:
percent - - percentage to brighten the module by

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
Overrides:
allLightsOn in class UnitPanel

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)
actionPerformed handles clicks on the On and Off buttons

Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
event - the ActionEvent describing the source of the action.

getTitle

public java.lang.String getTitle()
getTitle returns the title associated with this panel

Returns:
String the title assigned to this panel

setTitle

public void setTitle(java.lang.String title)
setTitle sets the title that appears at the top of this panel

Parameters:
title - the title to appear at the top of this panel

getState

public boolean getState()
getState returns the current state of the associated module.

Returns:
boolean true if the associated module is On.. false otherwise.


Copyright ©2000-2005 Wade Wassenberg.
On the web: http://x10.homelinux.org.
Send bug reports to x10@wass.homelinux.net.
Last Modified June 1, 2005