Class FWCheckboxChoiceSubComponent
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
net.simplace.pipe.formcomponents.FWAbstractFormSubComponent
net.simplace.pipe.formcomponents.choice.FWCheckboxChoiceSubComponent
- All Implemented Interfaces:
ItemListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
public class FWCheckboxChoiceSubComponent
extends FWAbstractFormSubComponent
implements ItemListener
This class is used by FWChoiceFormComponent, to display a list of choices from which
any number of items may be selected (one checkbox per option, in a scrollable container). If required, at least
one checkbox stays selected. Parameters of the form component:
multiselect_seperator- separator of the selected values (default,); if it contains', the values are quotedsql_where_param- if set, the value is an SQL condition<param>='v1' OR <param>='v2' ...
- Author:
- ckunze
- 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 FWAbstractFormSubComponent
iFormComponentParameterMap, iIsEnabled, iObservableFields 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 ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionFWCheckboxChoiceSubComponent(Vector<FWFormOption> aOptions, boolean aIsRequired, boolean aEnabled, boolean aShowAll, net.simplace.core.FWObservable aObservable, Map<String, Object> aFormComponentParameterMap, String aDefaultValue) FWCheckboxChoiceSubComponent(Vector<FWFormOption> aOptions, boolean aEnabled, boolean aShowAll, net.simplace.core.FWObservable aObservable, Map<String, Object> aFormComponentParameterMap) FWCheckboxChoiceSubComponent(Vector<FWFormOption> aOptions, boolean aEnabled, net.simplace.core.FWObservable aObservable, Map<String, Object> aFormComponentParameterMap) FWCheckboxChoiceSubComponent(Vector<FWFormOption> aOptions, boolean aEnabled, net.simplace.core.FWObservable aObservable, Map<String, Object> aFormComponentParameterMap, String aDefaultValue) -
Method Summary
Modifier and TypeMethodDescriptiongetValue()voidKeeps at least one checkbox selected (if required and there are several) and notifies the listeners.voidsetEnabled(boolean aIsEnabled) Enables or disables all checkboxes.voidsetSelectedIDs(String aIDs) Selects the checkboxes with the given ids (ALLselects all).voidSelects the checkboxes whose values are in the list (ALLselects all).voidupdateCheckBoxes(Vector<FWFormOption> aFormOptionVector) Replaces the checkboxes by new ones for the given options and notifies the listeners.Methods inherited from class FWAbstractFormSubComponent
addChangeListener, createSqlOrCondition, fireStateChanged, getChangeListeners, getLocaleValue, isEnabled, removeChangeListenerMethods 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, 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, 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, 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, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Constructor Details
-
FWCheckboxChoiceSubComponent
public FWCheckboxChoiceSubComponent(Vector<FWFormOption> aOptions, boolean aEnabled, net.simplace.core.FWObservable aObservable, Map<String, Object> aFormComponentParameterMap) - Parameters:
aOptions- list of options to be displayed to the useraEnabled-trueif the checkboxes are enabledaObservable- parameters of the functionalityaFormComponentParameterMap- parameters of the containing form component
-
FWCheckboxChoiceSubComponent
public FWCheckboxChoiceSubComponent(Vector<FWFormOption> aOptions, boolean aEnabled, boolean aShowAll, net.simplace.core.FWObservable aObservable, Map<String, Object> aFormComponentParameterMap) - Parameters:
aOptions- list of options to be displayed to the useraEnabled-trueif the checkboxes are enabledaShowAll-trueto show all options without vertical scroll baraObservable- parameters of the functionalityaFormComponentParameterMap- parameters of the containing form component
-
FWCheckboxChoiceSubComponent
public FWCheckboxChoiceSubComponent(Vector<FWFormOption> aOptions, boolean aEnabled, net.simplace.core.FWObservable aObservable, Map<String, Object> aFormComponentParameterMap, String aDefaultValue) - Parameters:
aOptions- list of options to be displayed to the useraEnabled-trueif the checkboxes are enabledaObservable- parameters of the functionalityaFormComponentParameterMap- parameters of the containing form componentaDefaultValue- comma-separated ids of the checkboxes initially selected (ALLfor all)
-
FWCheckboxChoiceSubComponent
public FWCheckboxChoiceSubComponent(Vector<FWFormOption> aOptions, boolean aIsRequired, boolean aEnabled, boolean aShowAll, net.simplace.core.FWObservable aObservable, Map<String, Object> aFormComponentParameterMap, String aDefaultValue) - Parameters:
aOptions- list of options to be displayed to the useraIsRequired-trueif at least one option must be selectedaEnabled-trueif the checkboxes are enabledaShowAll-trueto show all options without vertical scroll baraObservable- parameters of the functionalityaFormComponentParameterMap- parameters of the containing form componentaDefaultValue- comma-separated ids of the checkboxes initially selected (ALLfor all)
-
-
Method Details
-
getValue
- Specified by:
getValuein classFWAbstractFormSubComponent- Returns:
- the values of the selected checkboxes, separated by
multiselect_seperator, or an SQL condition ifsql_where_paramis set; with a single checkbox and nothing selected the default value
-
getSelectedValueList
- Specified by:
getSelectedValueListin classFWAbstractFormSubComponent- Returns:
- the values of the selected checkboxes
-
setValue
Selects the checkboxes whose values are in the list (ALLselects all). If no value matches, the list is interpreted as ids (seesetSelectedIDs(String)).- Specified by:
setValuein classFWAbstractFormSubComponent- Parameters:
aValue- comma-separated list of the values (or ids) to be selected;nullis ignored
-
setSelectedIDs
Selects the checkboxes with the given ids (ALLselects all).- Parameters:
aIDs- comma-separated list of the ids to be selected;nullselects the first checkbox if required
-
updateCheckBoxes
Replaces the checkboxes by new ones for the given options and notifies the listeners. Options that were selected before (same id) stay selected; if none of them exists any more, the first checkbox is selected if required.- Parameters:
aFormOptionVector- the new options
-
setEnabled
public void setEnabled(boolean aIsEnabled) Enables or disables all checkboxes.- Overrides:
setEnabledin classFWAbstractFormSubComponent- Parameters:
aIsEnabled-trueto enable
-
itemStateChanged
Keeps at least one checkbox selected (if required and there are several) and notifies the listeners.- Specified by:
itemStateChangedin interfaceItemListener- Parameters:
e- the item event
-