fr.esrf.tangoatk.widget.command
Class SettableCommandButtonViewer

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.AbstractButton
                  javax.swing.JButton
                      fr.esrf.tangoatk.widget.command.SimpleCommandButtonViewer
                          fr.esrf.tangoatk.widget.command.SettableCommandButtonViewer

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.SwingConstants

public class SettableCommandButtonViewer
extends SimpleCommandButtonViewer

A SimpleCommandButtonViewer which command's input can be set.

See Also:

SimpleCommandButtonViewer, Serialized Form

Nested Class Summary

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

javax.swing.JButton.AccessibleJButton

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

javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

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

Field Summary

protected boolean	askConfirmation
protected java.lang.String	askConfirmationText
protected java.lang.String	askConfirmationTitle
protected java.lang.String	buttonText
protected java.lang.String[]	commandInput
protected boolean	defaultHelpText
protected java.lang.String	errorReasonTitle
protected java.lang.String	errorText
protected java.lang.String	errorTitle
protected java.lang.String	helpText
protected java.util.List<java.lang.String>	m_argin
protected boolean	threadedCommand

Fields inherited from class fr.esrf.tangoatk.widget.command.SimpleCommandButtonViewer

acv, argFrame, borderVisble, cancelButtonVisible, commandModel, descriptionVisible, deviceButtonVisible, infoButtonVisible

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from class javax.swing.JComponent

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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

SettableCommandButtonViewer()
Constructor

Method Summary

void	actionPerformed(java.awt.event.ActionEvent event)
protected void	displayErrorMessage(java.lang.Throwable error, ICommand command) Displays an error message in a dialog.
java.lang.String	getAskConfirmationText() Returns the execution confirmation text
java.lang.String	getAskConfirmationTitle() Returns the confirmation title
java.lang.String	getButtonText()
java.lang.String[]	getCommandInput() Returns the command input
java.lang.String	getErrorReasonTitle()
java.lang.String	getErrorText()
java.lang.String	getErrorTitle()
java.lang.String	getHelpText()
boolean	isAskConfirmation() Returns whether execution confirmation will be asked to user.
boolean	isDefaultHelpText() Returns whether the default help text is used
boolean	isThreadedCommand() Returns whether command will be launched through a thread or not.
static void	main(java.lang.String[] args)
void	setAskConfirmation(boolean askConfirmation) Sets whether execution confirmation will be asked to user.
void	setAskConfirmationText(java.lang.String textAskConfirmation) Sets the execution confirmation text
void	setAskConfirmationTitle(java.lang.String titleAskConfirmation) Sets the confirmation title
void	setButtonText(java.lang.String buttonText)
void	setCommandInput(java.lang.String[] input) Sets the command input
void	setDefaultHelpText(boolean defaultHelpText) Sets whether you wish to use the default help textx
void	setErrorReasonTitle(java.lang.String errorReasonTitle)
void	setErrorText(java.lang.String errorText)
void	setErrorTitle(java.lang.String errorTitle)
void	setHelpText(java.lang.String helpText) Sets the button help text
void	setThreadedCommand(boolean threadedCommand) Sets whether to launch command through a thread or not.

Methods inherited from class fr.esrf.tangoatk.widget.command.SimpleCommandButtonViewer

clearModel, getCommandModel, isBorderVisible, isCancelButtonVisible, isDescriptionVisible, isDeviceButtonVisible, isInfoButtonVisible, setBorderVisible, setCancelButtonVisible, setCommandModel, setDescriptionVisible, setDeviceButtonVisible, setInfoButtonVisible

Methods inherited from class javax.swing.JButton

configurePropertiesFromAction, getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, 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, addPropertyChangeListener, 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, transferFocusBackward, 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, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, 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

defaultHelpText

protected boolean defaultHelpText

helpText

protected java.lang.String helpText

buttonText

protected java.lang.String buttonText

askConfirmation

protected boolean askConfirmation

askConfirmationTitle

protected java.lang.String askConfirmationTitle

askConfirmationText

protected java.lang.String askConfirmationText

errorTitle

protected java.lang.String errorTitle

errorText

protected java.lang.String errorText

errorReasonTitle

protected java.lang.String errorReasonTitle

commandInput

protected java.lang.String[] commandInput

m_argin

protected java.util.List<java.lang.String> m_argin

threadedCommand

protected boolean threadedCommand

Constructor Detail

SettableCommandButtonViewer

public SettableCommandButtonViewer()

Constructor

Method Detail

getHelpText

public java.lang.String getHelpText()

Returns:

Returns the helpText.

setHelpText

public void setHelpText(java.lang.String helpText)

Sets the button help text

Parameters:

helpText - The help text to set.

isDefaultHelpText

public boolean isDefaultHelpText()

Returns whether the default help text is used

Returns:

a boolean value. True if the default help text is used, False otherwise

setDefaultHelpText

public void setDefaultHelpText(boolean defaultHelpText)

Sets whether you wish to use the default help textx

Parameters:

defaultHelpText - a boolean value. True to use the default help text, False otherwise

setCommandInput

public void setCommandInput(java.lang.String[] input)

Sets the command input

Parameters:

input - The command input to set, represented as a String[].

getCommandInput

public java.lang.String[] getCommandInput()

Returns the command input

Returns:

the command input represented as a String[]

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class SimpleCommandButtonViewer

getButtonText

public java.lang.String getButtonText()

Returns:

Returns the button text.

setButtonText

public void setButtonText(java.lang.String buttonText)

Parameters:

buttonText - The button text to set.

isAskConfirmation

public boolean isAskConfirmation()

Returns whether execution confirmation will be asked to user.

Returns:

a boolean value

setAskConfirmation

public void setAskConfirmation(boolean askConfirmation)

Sets whether execution confirmation will be asked to user.

Parameters:

askConfirmation - a boolean value

getAskConfirmationText

public java.lang.String getAskConfirmationText()

Returns the execution confirmation text

Returns:

a String

setAskConfirmationText

public void setAskConfirmationText(java.lang.String textAskConfirmation)

Sets the execution confirmation text

Parameters:

textAskConfirmation - a String

getAskConfirmationTitle

public java.lang.String getAskConfirmationTitle()

Returns the confirmation title

Returns:

the confirmation title

setAskConfirmationTitle

public void setAskConfirmationTitle(java.lang.String titleAskConfirmation)

Sets the confirmation title

Parameters:

titleAskConfirmation -

displayErrorMessage

protected void displayErrorMessage(java.lang.Throwable error,
                                   ICommand command)

Displays an error message in a dialog.

Parameters:

error - The throwable which represents the reason of the error

command - The command which is the source of the error

getErrorTitle

public java.lang.String getErrorTitle()

Returns:

the errorTitle

setErrorTitle

public void setErrorTitle(java.lang.String errorTitle)

Parameters:

errorTitle - the errorTitle to set

getErrorText

public java.lang.String getErrorText()

Returns:

the errorText

setErrorText

public void setErrorText(java.lang.String errorText)

Parameters:

errorText - the errorText to set

getErrorReasonTitle

public java.lang.String getErrorReasonTitle()

Returns:

the errorReasonTitle

setErrorReasonTitle

public void setErrorReasonTitle(java.lang.String errorReasonTitle)

Parameters:

errorReasonTitle - the errorReasonTitle to set

isThreadedCommand

public boolean isThreadedCommand()

Returns whether command will be launched through a thread or not.

Returns:

a boolean value. True if a thread will be used, False otherwise.

setThreadedCommand

public void setThreadedCommand(boolean threadedCommand)

Sets whether to launch command through a thread or not.

Parameters:

threadedCommand - a boolean value. True if a thread will be used, False otherwise.

main

public static void main(java.lang.String[] args)
                 throws ConnectionException,
                        fr.esrf.Tango.DevFailed

Throws:

ConnectionException

fr.esrf.Tango.DevFailed