Package 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:
ActionListener,ImageObserver,ItemSelectable,MenuContainer,Serializable,EventListener,Accessible,SwingConstants
A SimpleCommandButtonViewer which command's input can be set.
- Author:
- HO
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JButton
JButton.AccessibleJButtonNested classes/interfaces inherited from class javax.swing.AbstractButton
AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListenerNested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanprotected Stringprotected Stringprotected Stringprotected String[]protected booleanprotected Stringprotected Stringprotected Stringprotected Stringprotected booleanFields inherited from class fr.esrf.tangoatk.widget.command.SimpleCommandButtonViewer
acv, argFrame, borderVisble, cancelButtonVisible, commandModel, descriptionVisible, deviceButtonVisible, infoButtonVisibleFields 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_PROPERTYFields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields 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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidactionPerformed(ActionEvent event) protected voiddisplayErrorMessage(Throwable error, fr.esrf.tangoatk.core.ICommand command) Displays an error message in a dialog.Returns the execution confirmation textReturns the confirmation titleString[]Returns the command inputbooleanReturns whether execution confirmation will be asked to user.booleanReturns whether the default help text is usedbooleanReturns whether command will be launched through a thread or not.static voidvoidsetAskConfirmation(boolean askConfirmation) Sets whether execution confirmation will be asked to user.voidsetAskConfirmationText(String textAskConfirmation) Sets the execution confirmation textvoidsetAskConfirmationTitle(String titleAskConfirmation) Sets the confirmation titlevoidsetButtonText(String buttonText) voidsetCommandInput(String[] input) Sets the command inputvoidsetDefaultHelpText(boolean defaultHelpText) Sets whether you wish to use the default help textxvoidsetErrorReasonTitle(String errorReasonTitle) voidsetErrorText(String errorText) voidsetErrorTitle(String errorTitle) voidsetHelpText(String helpText) Sets the button help textvoidsetThreadedCommand(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, setInfoButtonVisibleMethods inherited from class javax.swing.JButton
getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUIMethods inherited from class javax.swing.AbstractButton
actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, 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, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPositionMethods 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, 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, updateMethods 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, transferFocusDownCycle, validate, validateTreeMethods 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, 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
-
Field Details
-
defaultHelpText
protected boolean defaultHelpText -
helpText
-
buttonText
-
askConfirmation
protected boolean askConfirmation -
askConfirmationTitle
-
askConfirmationText
-
errorTitle
-
errorText
-
errorReasonTitle
-
commandInput
-
m_argin
-
threadedCommand
protected boolean threadedCommand
-
-
Constructor Details
-
SettableCommandButtonViewer
public SettableCommandButtonViewer()Constructor
-
-
Method Details
-
getHelpText
- Returns:
- Returns the helpText.
-
setHelpText
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.
Trueif the default help text is used,Falseotherwise
-
setDefaultHelpText
public void setDefaultHelpText(boolean defaultHelpText) Sets whether you wish to use the default help textx- Parameters:
defaultHelpText- a boolean value.Trueto use the default help text,Falseotherwise
-
setCommandInput
Sets the command input- Parameters:
input- The command input to set, represented as a String[].
-
getCommandInput
Returns the command input- Returns:
- the command input represented as a String[]
-
actionPerformed
- Specified by:
actionPerformedin interfaceActionListener- Overrides:
actionPerformedin classSimpleCommandButtonViewer
-
getButtonText
- Returns:
- Returns the button text.
-
setButtonText
- 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
Returns the execution confirmation text- Returns:
- a String
-
setAskConfirmationText
Sets the execution confirmation text- Parameters:
textAskConfirmation- a String
-
getAskConfirmationTitle
Returns the confirmation title- Returns:
- the confirmation title
-
setAskConfirmationTitle
Sets the confirmation title- Parameters:
titleAskConfirmation- Title of confirmation window
-
displayErrorMessage
Displays an error message in a dialog.- Parameters:
error- The throwable which represents the reason of the errorcommand- The command which is the source of the error
-
getErrorTitle
- Returns:
- the errorTitle
-
setErrorTitle
- Parameters:
errorTitle- the errorTitle to set
-
getErrorText
- Returns:
- the errorText
-
setErrorText
- Parameters:
errorText- the errorText to set
-
getErrorReasonTitle
- Returns:
- the errorReasonTitle
-
setErrorReasonTitle
- 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.
Trueif a thread will be used,Falseotherwise.
-
setThreadedCommand
public void setThreadedCommand(boolean threadedCommand) Sets whether to launch command through a thread or not.- Parameters:
threadedCommand- a boolean value.Trueif a thread will be used,Falseotherwise.
-
main
public static void main(String[] args) throws fr.esrf.tangoatk.core.ConnectionException, fr.esrf.Tango.DevFailed - Throws:
fr.esrf.tangoatk.core.ConnectionExceptionfr.esrf.Tango.DevFailed
-