Class FWChoiceFormComponent
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
net.simplace.pipe.formcomponents.FWAbstractFormComponent
net.simplace.pipe.formcomponents.choice.FWChoiceFormComponent
- All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener, net.simplace.core.FWBusyIndicator, net.simplace.core.FWObserver
Form component to choose one or several options. The options come from
option children
(attributes id, label, image; text or a result child as value;
without label the text is localised from the id) or dynamically from a form filler. The component delegates the
display to a choice subcomponent, chosen by the attribute type (list,
radio, combo, check, singlecheck) or automatically:
- required, multiple selection: list
- required, single selection: radio buttons (up to 5 options) or combo box
- not required: checkboxes (multiple selection) or combo box
multiselect, showAll, localize (all with parameter
tokens), default. Without options, or if the type does not fit the multiple selection setting, a
label is shown instead.- Author:
- ckunze, 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
ConstructorsConstructorDescriptionFWChoiceFormComponent(String aFormId, String aFieldId, boolean aShowBorder, org.jdom2.Element aParameters, net.simplace.core.FWObservable aObservable) Constructs a new choice form component and initializes it with aParameters. -
Method Summary
Modifier and TypeMethodDescriptiongetValue()protected com.lowagie.text.RectanglegetValueCell(int aType) Returns the value cell used for generating the RTF, PDF or HTML version of the form.voidTakes the options from the form filler (optionally all with the imageformFiller.image) and updates the subcomponent; a label subcomponent is replaced by an appropriate one and vice versa if there are no options.voidsetEnabled(boolean aIsEnabled) voidSelects the option(s) with the given value and notifies dependent components, if the value changes.voidstateChanged(ChangeEvent aEvent) Notifies other controls, if the choice's value has changed.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
-
FWChoiceFormComponent
public FWChoiceFormComponent(String aFormId, String aFieldId, boolean aShowBorder, org.jdom2.Element aParameters, net.simplace.core.FWObservable aObservable) Constructs a new choice form component and initializes it with aParameters.- Parameters:
aFormId- id of the form the component is placed inaFieldId- id of the component, also the parameter key of its valueaShowBorder-trueto show a caption labelaParameters- the form element with attributes andoptionchildrenaObservable- parameters of the functionality
-
-
Method Details
-
getValue
- Specified by:
getValuein classFWAbstractFormComponent- Returns:
- the value of the selected option(s), as provided by the subcomponent
-
setValue
Selects the option(s) with the given value and notifies dependent components, if the value changes.- Specified by:
setValuein classFWAbstractFormComponent- Parameters:
aValue- the value to select
-
setEnabled
public void setEnabled(boolean aIsEnabled) - Overrides:
setEnabledin classJComponent- Parameters:
aIsEnabled-trueto enable the subcomponent
-
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:
aObservabal- the parametersaKeyOfParameterChanged- key of the changed parameter
-
stateChanged
Notifies other controls, if the choice's value has changed.- Specified by:
stateChangedin interfaceChangeListener- Parameters:
aEvent- the change event of the subcomponent
-
processFormFiller
public void processFormFiller()Takes the options from the form filler (optionally all with the imageformFiller.image) and updates the subcomponent; a label subcomponent is replaced by an appropriate one and vice versa if there are no options.- 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)
-