Class FWProcessorButtonFormComponent
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
net.simplace.pipe.formcomponents.FWAbstractFormComponent
net.simplace.pipe.formcomponents.button.FWProcessorButtonFormComponent
- All Implemented Interfaces:
ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, net.simplace.core.FWBusyIndicator, net.simplace.core.FWObserver
public class FWProcessorButtonFormComponent
extends FWAbstractFormComponent
implements ActionListener
Form component that runs a processor (the form element with its
class attribute) when the button
is clicked, or the function given in the parameter function. With type toggle the
button is a toggle button: the first click creates the processor and pipes with value true, the
second pipes the same processor with false (e.g. to start and stop a server).
| Parameter | Description |
|---|---|
type |
type of button from static list of types (e.g. go, ok, start, stop, toggle), default: go. |
- Author:
- Andreas Enders
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class JPanel
JPanel.AccessibleJPanelNested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
Fields inherited from class FWAbstractFormComponent
COPY_BUTTON_DEFAULT_IMAGE, COPY_BUTTON_DISABLED_IMAGE, COPY_BUTTON_HIGHLIGHT_IMAGE, DETACH_AUTO, DETACH_BUTTON, DETACH_FALSE, DETACH_LINKED, DETACH_TRUE, DETATCH_BORDER_DEFAULT_COLOR, DETATCH_BORDER_HIGHLIGHT_COLOR, DETATCH_BORDER_WIDTH, DETATCH_BUTTON_DEFAULT_IMAGE, DETATCH_BUTTON_DISABLED_IMAGE, DETATCH_BUTTON_HIGHLIGHT_IMAGE, EXPORT_BUTTON_DEFAULT_IMAGE, EXPORT_BUTTON_DISABLED_IMAGE, EXPORT_BUTTON_HIGHLIGHT_IMAGE, iDetachContentPanel, iObservable, PRINT_BUTTON_DEFAULT_IMAGE, PRINT_BUTTON_DISABLED_IMAGE, PRINT_BUTTON_HIGHLIGHT_IMAGEFields inherited from class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface net.simplace.core.FWBusyIndicator
BUSY_STEPSFields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionFWProcessorButtonFormComponent(String aFormId, String aFieldId, boolean aShowBorder, org.jdom2.Element aParameters, net.simplace.core.FWObservable aObservabal) -
Method Summary
Modifier and TypeMethodDescriptionvoidRuns the function (parameterfunction) or the processor (see class description) while showing an animated progress cursor.getValue()protected com.lowagie.text.RectanglegetValueCell(int aType) Returns the value cell used for generating the RTF, PDF or HTML version of the form.voidFills the component from its form filler (e.g.voidsetEnabled(boolean aNewState) voidSets the state of a toggle button; no effect for other buttons.voidReacts to a changed parameter: re-evaluatesenabledandvisible(a disabled or hidden component is reset to its default), resets the default value and re-runs the form filler, if the changed parameter is used in them.Methods inherited from class FWAbstractFormComponent
add, add, attachPanel, closeFormComponent, createDetachControls, detachPanel, disposePanel, exportData, getCells, getComponentParameteterValue, getConfiguration, getDetachability, getFieldID, getFormElement, getFormFiller, getFormID, getJumper, getJumperRule, getLocaleValue, getLocaleValue, getMaximumSize, getObservable, getOriginalComponentParameteterValue, getPreferredSize, getRequiredWarning, getSystemID, getTitle, hasConfiguration, hasFormFiller, hideBusy, init, isClosingRequired, isEnabled, isRequired, notifyDependentComponents, remove, setConfiguration, setDefault, setDetachControlsEnabled, setDetachControlsHighlighted, setFieldID, setFormElement, setFormID, setObservable, setRequired, setTitle, setUpDetachControl, showBusy, toStringMethods inherited from class JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIMethods inherited from class 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, getMinimumSize, getNextFocusableComponent, getPopupLocation, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, updateMethods inherited from class Container
add, add, add, add, addContainerListener, addImpl, 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, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTreeMethods inherited from class 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, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, 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, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Constructor Details
-
FWProcessorButtonFormComponent
public FWProcessorButtonFormComponent(String aFormId, String aFieldId, boolean aShowBorder, org.jdom2.Element aParameters, net.simplace.core.FWObservable aObservabal) - Parameters:
aFormId- id of the form the component is placed inaFieldId- id of the component; also the locale key of the button textaShowBorder-trueto show a caption labelaParameters- the form element (processor definition, attributetype)aObservabal- parameters of the functionality
-
-
Method Details
-
getValue
- Specified by:
getValuein classFWAbstractFormComponent- Returns:
"true"/"false"for a toggle button, otherwise an empty string
-
setValue
Sets the state of a toggle button; no effect for other buttons.- Specified by:
setValuein classFWAbstractFormComponent- Parameters:
aValue-true/false
-
setEnabled
public void setEnabled(boolean aNewState) - Overrides:
setEnabledin classJComponent- Parameters:
aNewState-trueto enable the button
-
actionPerformed
Runs the function (parameterfunction) or the processor (see class description) while showing an animated progress cursor. Note: it runs on the event dispatch thread (the GUI is blocked meanwhile), and the processor is created without pipeline container, so processors needing one (e.g. loop processors) fail with a logged error.- Specified by:
actionPerformedin interfaceActionListener- Parameters:
e- the button event
-
update
Description copied from class:FWAbstractFormComponentReacts to a changed parameter: re-evaluatesenabledandvisible(a disabled or hidden component is reset to its default), resets the default value and re-runs the form filler, if the changed parameter is used in them. Changes of the component's own value are ignored.- Specified by:
updatein interfacenet.simplace.core.FWObserver- Overrides:
updatein classFWAbstractFormComponent- Parameters:
aObservable- the parametersaKeyOfParameterChanged- key of the changed parameter
-
processFormFiller
public void processFormFiller()Description copied from class:FWAbstractFormComponentFills the component from its form filler (e.g. options or a chart); called after initialisation and whenever the jumper rule of the form filler changes.- Specified by:
processFormFillerin classFWAbstractFormComponent
-
getValueCell
protected com.lowagie.text.Rectangle getValueCell(int aType) Description copied from class:FWAbstractFormComponentReturns the value cell used for generating the RTF, PDF or HTML version of the form.- Specified by:
getValueCellin classFWAbstractFormComponent- Parameters:
aType- output type, e.g.PrintHelper.TYPE_PDF- Returns:
- an iText cell (
PdfPCellfor PDF,Cellotherwise)
-