Package org.harctoolbox.guicomponents

Class GirsClientBean

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.harctoolbox.guicomponents.HardwareBean

org.harctoolbox.guicomponents.GirsClientBean

All Implemented Interfaces:

ImageObserver, MenuContainer, Closeable, Serializable, AutoCloseable, Accessible

public final class GirsClientBean
extends HardwareBean

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GirsClientBean.Type

Nested classes/interfaces inherited from class org.harctoolbox.guicomponents.HardwareBean

HardwareBean.CannotCaptureException, 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
static final int	DEFAULT_BAUD
static final String	DEFAULT_IPNAME
static final int	DEFAULT_PORT
static final String	DEFAULT_PORTNAME
static final int	DEFAULT_TIMEOUT
static final GirsClientBean.Type	DEFAULT_TYPE

Fields inherited from class org.harctoolbox.guicomponents.HardwareBean

guiUtils, hardware, NOT_CONNECTED, NOT_INITIALIZED, PROP_BAUD, PROP_IPNAME, PROP_ISOPEN, PROP_LOWER_DTR_RTS, PROP_MODULE, PROP_PORT, PROP_PORTNAME, PROP_PROPS, PROP_TYPE, PROP_VERSION, propertyChangeSupport, timeout, 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

Constructor Summary

Constructors

Constructor	Description
GirsClientBean()
GirsClientBean(GuiUtils guiUtils, boolean verbose)
GirsClientBean(GuiUtils guiUtils, boolean verbose, int timeout, String initialPort, int baud, String ipName, int portNumber, GirsClientBean.Type type)

Method Summary

Modifier and Type	Method	Description
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.
void	close()
int	getBaud()
String	getName()	Returns a somewhat friendly name of the class.
String	getPortName()
GirsClientBean.Type	getType()
String	getVersion()
boolean	isPingable(boolean useGui)
void	open()
boolean	sendIr(org.harctoolbox.ircore.IrSignal irSignal, int count)	Default implementation, override whenever the subclass can send.
void	setBaud(int baud)
void	setIpName(String name)
void	setPort(int portNumber)
void	setPortName(String portName)
void	setType(String typeName)
void	setType(GirsClientBean.Type type)

Methods inherited from class org.harctoolbox.guicomponents.HardwareBean

addPropertyChangeListener, assertHardwareNonNull, assertHardwareValid, getHardware, isOpen, openClose, removePropertyChangeListener, resetCursor, setBusyCursor, setTimeout, setVerbose

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

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

• Constant Field Values

DEFAULT_BAUD

public static final int DEFAULT_BAUD

See Also:

• Constant Field Values

DEFAULT_TYPE

public static final GirsClientBean.Type DEFAULT_TYPE

DEFAULT_PORTNAME

public static final String DEFAULT_PORTNAME

See Also:

• Constant Field Values

DEFAULT_IPNAME

public static final String DEFAULT_IPNAME

See Also:

• Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

• Constant Field Values

Constructor Details

GirsClientBean

public GirsClientBean()

GirsClientBean

public GirsClientBean(GuiUtils guiUtils,
 boolean verbose)

GirsClientBean

public GirsClientBean(GuiUtils guiUtils,
 boolean verbose,
 int timeout,
 String initialPort,
 int baud,
 String ipName,
 int portNumber,
 GirsClientBean.Type type)

Method Details

sendIr

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

Description copied from class: HardwareBean

Default implementation, override whenever the subclass can send.

Overrides:

sendIr in class HardwareBean

Returns:

success of operation

Throws:

IOException

org.harctoolbox.harchardware.ir.NoSuchTransmitterException

org.harctoolbox.harchardware.HarcHardwareException

capture

public org.harctoolbox.ircore.ModulatedIrSequence capture()
                                                   throws org.harctoolbox.harchardware.HarcHardwareException,
org.harctoolbox.ircore.OddSequenceLengthException,
IOException

Description copied from class: HardwareBean

Default implementation, override whenever the subclass can capture.

Overrides:

capture in class HardwareBean

Returns:

ModulatedSequence captured, or null.

Throws:

HardwareBean.CannotCaptureException

org.harctoolbox.harchardware.HarcHardwareException

IOException

org.harctoolbox.ircore.OddSequenceLengthException

getName

public String getName()

Description copied from class: HardwareBean

Returns a somewhat friendly name of the class.

Overrides:

getName in class HardwareBean

Returns:

name

setPort

public void setPort(int portNumber)

setType

public void setType(String typeName)

setType

public void setType(GirsClientBean.Type type)

getType

public GirsClientBean.Type getType()

getPortName

public String getPortName()

Returns:

the port

setPortName

public void setPortName(String portName)

Parameters:

portName - the port to set

getBaud

public int getBaud()

Returns:

the baudRate

setBaud

public void setBaud(int baud)

getVersion

public String getVersion()

Returns:

the version

setIpName

public void setIpName(String name)

isPingable

public boolean isPingable(boolean useGui)

canCapture

public boolean canCapture()

Description copied from class: HardwareBean

Default implementation, override whenever the subclass can capture.

Overrides:

canCapture in class HardwareBean

Returns:

false

canSend

public boolean canSend()

Description copied from class: HardwareBean

Default implementation, override whenever the subclass can send.

Overrides:

canSend in class HardwareBean

Returns:

false

open

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

Specified by:

open in class HardwareBean

Throws:

IOException

org.harctoolbox.harchardware.HarcHardwareException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class HardwareBean

Throws:

IOException