Package org.harctoolbox.guicomponents

Class HardwareBean

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.harctoolbox.guicomponents.HardwareBean

All Implemented Interfaces:

ImageObserver, MenuContainer, Closeable, Serializable, AutoCloseable, Accessible

Direct Known Subclasses:

AudioTransmitterBean, DevLircBean, GirsClientBean, GlobalCacheBean, SerialHardwareBean

public abstract class HardwareBean
extends JPanel
implements Closeable

This is a superclass of all the hardware managing beans.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HardwareBean.CannotCaptureException
static class	HardwareBean.CannotSendException

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected final GuiUtils	guiUtils
protected org.harctoolbox.harchardware.IHarcHardware	hardware
protected static final String	NOT_CONNECTED
protected static final String	NOT_INITIALIZED
static final String	PROP_BAUD
static final String	PROP_IPNAME
static final String	PROP_ISOPEN
static final String	PROP_LOWER_DTR_RTS
static final String	PROP_MODULE
static final String	PROP_PORT
static final String	PROP_PORTNAME
static final String	PROP_PROPS
static final String	PROP_TYPE
static final String	PROP_VERSION
protected final PropertyChangeSupport	propertyChangeSupport
protected int	timeout
protected boolean	verbose

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)
protected void	assertHardwareNonNull()
protected void	assertHardwareValid()
boolean	canCapture()	Default implementation, override whenever the subclass can capture.
boolean	canSend()	Default implementation, override whenever the subclass can send.
org.harctoolbox.ircore.ModulatedIrSequence	capture()	Default implementation, override whenever the subclass can capture.
abstract void	close()
org.harctoolbox.harchardware.IHarcHardware	getHardware()
String	getName()	Returns a somewhat friendly name of the class.
boolean	isOpen()
abstract void	open()
protected void	openClose(boolean opening)
void	removePropertyChangeListener(PropertyChangeListener listener)
protected void	resetCursor(Cursor cursor)
boolean	sendIr(org.harctoolbox.ircore.IrSignal irSignal, int count)	Default implementation, override whenever the subclass can send.
protected Cursor	setBusyCursor()
void	setTimeout(int timeout)
void	setVerbose(boolean verbose)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

PROP_VERSION

public static final String PROP_VERSION

See Also:

• Constant Field Values

PROP_BAUD

public static final String PROP_BAUD

See Also:

• Constant Field Values

PROP_ISOPEN

public static final String PROP_ISOPEN

See Also:

• Constant Field Values

PROP_PROPS

public static final String PROP_PROPS

See Also:

• Constant Field Values

PROP_PORTNAME

public static final String PROP_PORTNAME

See Also:

• Constant Field Values

PROP_IPNAME

public static final String PROP_IPNAME

See Also:

• Constant Field Values

PROP_MODULE

public static final String PROP_MODULE

See Also:

• Constant Field Values

PROP_PORT

public static final String PROP_PORT

See Also:

• Constant Field Values

PROP_TYPE

public static final String PROP_TYPE

See Also:

• Constant Field Values

PROP_LOWER_DTR_RTS

public static final String PROP_LOWER_DTR_RTS

See Also:

• Constant Field Values

NOT_INITIALIZED

protected static final String NOT_INITIALIZED

See Also:

• Constant Field Values

NOT_CONNECTED

protected static final String NOT_CONNECTED

See Also:

• Constant Field Values

propertyChangeSupport

protected final PropertyChangeSupport propertyChangeSupport

guiUtils

protected final GuiUtils guiUtils

verbose

protected boolean verbose

timeout

protected int timeout

hardware

protected org.harctoolbox.harchardware.IHarcHardware hardware

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Overrides:

addPropertyChangeListener in class Container

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Overrides:

removePropertyChangeListener in class Component

getHardware

public org.harctoolbox.harchardware.IHarcHardware getHardware()

setTimeout

public void setTimeout(int timeout)

Parameters:

timeout - the timeout to set

setVerbose

public void setVerbose(boolean verbose)

Parameters:

verbose - the verbose to set

openClose

protected void openClose(boolean opening)
                  throws IOException,
org.harctoolbox.harchardware.HarcHardwareException

Throws:

IOException

org.harctoolbox.harchardware.HarcHardwareException

getName

public String getName()

Returns a somewhat friendly name of the class.

Overrides:

getName in class Component

Returns:

name

open

public abstract void open()
                   throws IOException,
org.harctoolbox.harchardware.HarcHardwareException

Throws:

IOException

org.harctoolbox.harchardware.HarcHardwareException

close

public abstract void close()
                    throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

isOpen

public boolean isOpen()

assertHardwareNonNull

protected void assertHardwareNonNull()
                              throws HardwareUnavailableException

Throws:

HardwareUnavailableException

assertHardwareValid

protected void assertHardwareValid()
                            throws HardwareUnavailableException

Throws:

HardwareUnavailableException

setBusyCursor

protected Cursor setBusyCursor()

resetCursor

protected void resetCursor(Cursor cursor)

canCapture

public boolean canCapture()

Default implementation, override whenever the subclass can capture.

Returns:

false

canSend

public boolean canSend()

Default implementation, override whenever the subclass can send.

Returns:

false

capture

public org.harctoolbox.ircore.ModulatedIrSequence capture()
                                                   throws HardwareBean.CannotCaptureException,
org.harctoolbox.harchardware.HarcHardwareException,
org.harctoolbox.ircore.InvalidArgumentException,
IOException

Default implementation, override whenever the subclass can capture.

Returns:

ModulatedSequence captured, or null.

Throws:

HardwareBean.CannotCaptureException

org.harctoolbox.harchardware.HarcHardwareException

org.harctoolbox.ircore.InvalidArgumentException

IOException

sendIr

public boolean sendIr(org.harctoolbox.ircore.IrSignal irSignal,
 int count)
               throws org.harctoolbox.harchardware.ir.NoSuchTransmitterException,
IOException,
HardwareUnavailableException,
org.harctoolbox.harchardware.HarcHardwareException,
org.harctoolbox.ircore.InvalidArgumentException

Default implementation, override whenever the subclass can send.

Parameters:

irSignal -

count -

Returns:

success of operation

Throws:

org.harctoolbox.harchardware.ir.NoSuchTransmitterException

IOException

HardwareUnavailableException

org.harctoolbox.harchardware.HarcHardwareException

org.harctoolbox.ircore.InvalidArgumentException