S-PLUS Connect/Java v1.0

com.insightful.controls
Class SplusListBox

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended bycom.insightful.controls.SplusLabelBox
                  extended bycom.insightful.controls.SplusListBox
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, SplusControlMethods
Direct Known Subclasses:
SplusDataColumnListBox, SplusWideListBox

public class SplusListBox
extends SplusLabelBox
implements SplusControlMethods

Control with a JList in a JScrollPane and an associated JLabel.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes 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
SplusListBox()
           
SplusListBox(String text)
           
SplusListBox(String text, char mnemonic)
           
SplusListBox(String text, char mnemonic, String[] listData)
           
SplusListBox(String text, int mnemonic)
           
SplusListBox(String text, int mnemonic, String[] listData)
           
SplusListBox(String text, String[] listData)
           
 
Method Summary
 void addListSelectionListener(ListSelectionListener listener)
           
 void clearSelection()
           
 String[] getAppend()
           
 String[] getOptionList()
          Gets the option list for the control.
 String[] getPrepend()
           
 int getSelectedIndex()
           
 int[] getSelectedIndices()
           
 int getSelectionMode()
           
 String getValue()
          Get the selected values as a single comma-delimited string.
 String[] getValues()
          Get the selected values as a String array.
 boolean isEnabled()
          Check whether the control is enabled.
 boolean isSelectionEmpty()
           
 void setAppend(String[] str)
           
 void setEnabled(boolean b)
          Set whether the control is enabled.
 void setOptionList(String[] listData)
          Sets the option list for the control.
 void setPrepend(String[] str)
           
 void setSelectedIndex(int index)
           
 void setSelectedIndices(int[] indices)
           
 void setSelectionMode(int selectionMode)
           
 void setValue(String value)
          Sets the value of the control as a String.
 void setValues(String[] values)
           
 
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, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

SplusListBox

public SplusListBox()

SplusListBox

public SplusListBox(String text)

SplusListBox

public SplusListBox(String text,
                    char mnemonic)

SplusListBox

public SplusListBox(String text,
                    int mnemonic)

SplusListBox

public SplusListBox(String text,
                    char mnemonic,
                    String[] listData)

SplusListBox

public SplusListBox(String text,
                    int mnemonic,
                    String[] listData)

SplusListBox

public SplusListBox(String text,
                    String[] listData)
Method Detail

getValue

public String getValue()
Get the selected values as a single comma-delimited string.

Specified by:
getValue in interface SplusControlMethods
Returns:
String representation of the control's value.

getValues

public String[] getValues()
Get the selected values as a String array.


setValue

public void setValue(String value)
Description copied from interface: SplusControlMethods
Sets the value of the control as a String.

Specified by:
setValue in interface SplusControlMethods
Parameters:
value - desired control value

setValues

public void setValues(String[] values)

getOptionList

public String[] getOptionList()
Description copied from interface: SplusControlMethods
Gets the option list for the control. If the control has no option list, this will return either an array with no elements or a null.

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

setOptionList

public void setOptionList(String[] listData)
Description copied from interface: SplusControlMethods
Sets the option list for the control. If the control has no option list, this performs no action.

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

isEnabled

public boolean isEnabled()
Description copied from interface: SplusControlMethods
Check whether the control is enabled.

Specified by:
isEnabled in interface SplusControlMethods

setEnabled

public void setEnabled(boolean b)
Description copied from interface: SplusControlMethods
Set whether the control is enabled.

Specified by:
setEnabled in interface SplusControlMethods

addListSelectionListener

public void addListSelectionListener(ListSelectionListener listener)

clearSelection

public void clearSelection()

isSelectionEmpty

public boolean isSelectionEmpty()

getSelectedIndex

public int getSelectedIndex()

getSelectedIndices

public int[] getSelectedIndices()

setSelectedIndex

public void setSelectedIndex(int index)

setSelectedIndices

public void setSelectedIndices(int[] indices)

getSelectionMode

public int getSelectionMode()

setSelectionMode

public void setSelectionMode(int selectionMode)

setPrepend

public void setPrepend(String[] str)

getPrepend

public String[] getPrepend()

setAppend

public void setAppend(String[] str)

getAppend

public String[] getAppend()

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.