S-PLUS Connect/Java v1.0

com.insightful.controls
Class SplusComboBox

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by com.insightful.controls.SplusLabelBox
                  extended by com.insightful.controls.SplusComboBox
All Implemented Interfaces:
SplusControlMethods, ImageObserver, MenuContainer, Serializable
Direct Known Subclasses:
SplusColorControl, SplusDataColumnComboBox, SplusDataSetComboBox, SplusLineStyleControl, SplusObjectComboBox, SplusSymbolStyleControl, SplusTimeSeriesComboBox, SplusWideComboBox

public class SplusComboBox
extends SplusLabelBox
implements SplusControlMethods

Standard combo box control for S-PLUS dialogs. This component contains a JComboBox and an associated JLabel. The SplusLabelBox methods take care of layout and modifying the label.

By default the combo box is editable. A non-editable single-select control may be obtained by using setEditable(false).

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
SplusComboBox()
          Constructs a combo box with a blank label.
SplusComboBox(String text)
          Constructs a combo box with the specified label.
SplusComboBox(String text, char mnemonic)
          Constructs a combo box with the specified label and mnemonic.
SplusComboBox(String text, char mnemonic, String[] listData)
          Constructs a combo box with the specified label, mnemonic, and option list.
SplusComboBox(String text, int mnemonic)
          Constructs a combo box with the specified label and mnemonic.
SplusComboBox(String text, int mnemonic, String[] listData)
          Constructs a combo box with the specified label, mnemonic, and option list.
SplusComboBox(String text, String[] listData)
          Constructs a combo box with the specified label and option list.
 
Method Summary
 void addActionListener(ActionListener listener)
          Adds an actionListener to the list of action listeners for the control.
 void addItemListener(ItemListener listener)
          Adds an ItemListener to the list of item listeners for the control.
 String getActionCommand()
          Gets the action command for the combo box.
 String[] getAppend()
          Gets the current list of append items.
 String[] getOptionList()
          Returns the elements in the option list.
 String[] getPrepend()
          Gets the current list of prepend items.
 int getSelectedIndex()
          Gets the selected index in the combo box.
 String getValue()
          Gets current value of the combo box as a String.
 boolean isEditable()
          Checks whether the combo box is editable.
 boolean isEnabled()
          Checks whether the combo box is currently enabled.
 void setActionCommand(String aCommand)
          Sets the action command for the combo box.
 void setAppend(String[] str)
          Sets the list of items to append to the option list specified by setOptionList().
 void setEditable(boolean aFlag)
          Sets whether the combo box is editable.
 void setEnabled(boolean b)
          Sets the control to be enabled or disabled.
 void setOptionList(String[] listData)
          Sets the option list to contain the specified elements plus any append or prepend values defined by setAppend() and setPrepend().
 void setPrepend(String[] str)
          Sets the list of items to prepend to the option list specified by setOptionList().
 void setSelectedIndex(int anIndex)
          Sets the selected value based on an index into the option list.
 void setValue(String value)
          Sets the combo box to have a specified value.
 
Methods inherited from class com.insightful.controls.SplusLabelBox
getMnemonic, getText, setActionControl, setLabelEnabled, setLabelFor, setMnemonic, setMnemonic, setText
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, update, updateUI
 
Methods inherited from class java.awt.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, 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, 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, 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
 
Methods inherited from interface com.insightful.controls.SplusControlMethods
getMnemonic, getText, setMnemonic, setMnemonic, setText
 

Constructor Detail

SplusComboBox

public SplusComboBox()
Constructs a combo box with a blank label.


SplusComboBox

public SplusComboBox(String text)
Constructs a combo box with the specified label.

Parameters:
text - label for the combo box

SplusComboBox

public SplusComboBox(String text,
                     char mnemonic)
Constructs a combo box with the specified label and mnemonic.

Parameters:
text - label for the combo box
mnemonic - mnemonic specified as a char

SplusComboBox

public SplusComboBox(String text,
                     int mnemonic)
Constructs a combo box with the specified label and mnemonic.

Parameters:
text - label for the combo box
mnemonic - mnemonic for the combo box specified as an int

SplusComboBox

public SplusComboBox(String text,
                     char mnemonic,
                     String[] listData)
Constructs a combo box with the specified label, mnemonic, and option list.

Parameters:
text - label for the combo box
mnemonic - mnemonic specified as a char
listData - String array of option list elements

SplusComboBox

public SplusComboBox(String text,
                     int mnemonic,
                     String[] listData)
Constructs a combo box with the specified label, mnemonic, and option list.

Parameters:
text - label for the combo box
mnemonic - mnemonic specified as an int
listData - String array of option list elements

SplusComboBox

public SplusComboBox(String text,
                     String[] listData)
Constructs a combo box with the specified label and option list.

Parameters:
text - label for the combo box
listData - String array of option list elements
Method Detail

getValue

public String getValue()
Gets current value of the combo box as a String. Value is the empty string if no item is selected and field is blank.

Specified by:
getValue in interface SplusControlMethods
Returns:
combo box value

setValue

public void setValue(String value)
Sets the combo box to have a specified value. If the combo box is non-editable and the value is not in the option list, then no item is selected.

Specified by:
setValue in interface SplusControlMethods
Parameters:
value - desired combo box value

getSelectedIndex

public int getSelectedIndex()
Gets the selected index in the combo box. If no item is selected or the combo box is editable with a value not in the option list, the returned value is -1.

Returns:
index of selected value in option list

setSelectedIndex

public void setSelectedIndex(int anIndex)
Sets the selected value based on an index into the option list.

Parameters:
anIndex - int indicating which option list item to select

getOptionList

public String[] getOptionList()
Returns the elements in the option list. This will include any append and prepend values.

Specified by:
getOptionList in interface SplusControlMethods
Returns:
String array of the elements in the option list.

setOptionList

public void setOptionList(String[] listData)
Sets the option list to contain the specified elements plus any append or prepend values defined by setAppend() and setPrepend().

Specified by:
setOptionList in interface SplusControlMethods
Parameters:
listData - option list elements.

isEnabled

public boolean isEnabled()
Checks whether the combo box is currently enabled.

Specified by:
isEnabled in interface SplusControlMethods
Overrides:
isEnabled in class Component
Returns:
boolean indicating whether the control is enabled

setEnabled

public void setEnabled(boolean b)
Sets the control to be enabled or disabled.

Specified by:
setEnabled in interface SplusControlMethods
Overrides:
setEnabled in class JComponent
Parameters:
b - boolean indicating whether to enable the control

addActionListener

public void addActionListener(ActionListener listener)
Adds an actionListener to the list of action listeners for the control. An ActionEvent is dispatched when the underlying text field sends an action event or the control loses focus.

Parameters:
listener - listener for text field changes.

addItemListener

public void addItemListener(ItemListener listener)
Adds an ItemListener to the list of item listeners for the control.

Parameters:
listener - listener for item events

getActionCommand

public String getActionCommand()
Gets the action command for the combo box.

Returns:
action command.

setActionCommand

public void setActionCommand(String aCommand)
Sets the action command for the combo box.

Parameters:
aCommand - the desired action command

setPrepend

public void setPrepend(String[] str)
Sets the list of items to prepend to the option list specified by setOptionList(). This is useful for having items such as "<ALL>" or "<NONE>" always appear in a list along with other values which vary.

Parameters:
str - array of String items to prepend

getPrepend

public String[] getPrepend()
Gets the current list of prepend items. This may be of use to remove the prepend items from the list of items returned by getOptionList().

Returns:
array of items to prepend

setAppend

public void setAppend(String[] str)
Sets the list of items to append to the option list specified by setOptionList(). This is useful for having items such as "<ALL>" or "<NONE>" always appear in a list along with other values which vary.

Parameters:
str - array of String items to append

getAppend

public String[] getAppend()
Gets the current list of append items. This may be of use to remove the append items from the list of items returned by getOptionList().

Returns:
array of items to append.

isEditable

public boolean isEditable()
Checks whether the combo box is editable.

Returns:
boolean indicating whether the combo box is editable

setEditable

public void setEditable(boolean aFlag)
Sets whether the combo box is editable.

Parameters:
aFlag - boolean indicating whether the combo box is editable.

S-PLUS Connect/Java v1.0

Copyright © 2000, 2002 Insightful Corporation
Warning: Classes not documented in the S-PLUS Programmer's Guide may change in future releases.