VdexReload 1.1.3 API

uk.ac.reload.dweezil.gui.widgets
Class ReloadListBox

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byuk.ac.reload.dweezil.gui.widgets.ReloadListBox
All Implemented Interfaces:
javax.accessibility.Accessible, java.util.EventListener, java.awt.image.ImageObserver, javax.swing.event.ListSelectionListener, java.awt.MenuContainer, ReloadVocabularyListener, ReloadWidget, java.io.Serializable

public class ReloadListBox
extends javax.swing.JPanel
implements ReloadWidget, javax.swing.event.ListSelectionListener, ReloadVocabularyListener

A Combination of JTextField and JList

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  int _maxLength
          The maximum number of characters allowed
protected  ReloadVocabularyList _rvList
          The Reload Vocabulary List
protected  javax.swing.JList listBox
          A list box to display the list
protected  javax.swing.JTextField textField
          A Textfield to display the value
 
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
ReloadListBox()
          Constructor
 
Method Summary
 void addDocumentListener(javax.swing.event.DocumentListener dl)
          Add a DocumentListener to the Text Box
 void destroy()
          Destroy, remove the ReloadVocabularyListener
 javax.swing.JList getListBox()
          Get the List Box
 javax.swing.JTextField getTextField()
          Get the Text Field
 java.lang.String getTextValue()
          Get the Value from the TextField
 void insertTextValue(java.lang.String text)
          Insert some text
 boolean isSingleLine()
          Determine whether this widget only needs a single line to display itself
 void removeDocumentListener(javax.swing.event.DocumentListener dl)
          Remove a DocumentListener from the Text Box
 void setEnabled(boolean enabled)
          Set the components enabled/disabled
 void setList(ReloadVocabularyList rvList)
          Set the VocabularyList
 void setListData(java.lang.Object[] values)
          Set the Lists Data
 void setMaxLength(int maxLength)
          Set the maximum allowed of digits
 void setTextValue(java.lang.String value)
          Set this value to the TextField and set this value as the current selected item in the ListBox
 void valueChanged(javax.swing.event.ListSelectionEvent e)
          ListSelection Listener for the Vocabulary List and update the Text Field
 void vocabularyListChanged(ReloadVocabularyListenerEvent event)
          Update the ListBox items since the Vocabulary List has changed
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
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, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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
 
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, isEnabled, 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
 

Field Detail

_maxLength

protected int _maxLength
The maximum number of characters allowed


textField

protected javax.swing.JTextField textField
A Textfield to display the value


listBox

protected javax.swing.JList listBox
A list box to display the list


_rvList

protected ReloadVocabularyList _rvList
The Reload Vocabulary List

Constructor Detail

ReloadListBox

public ReloadListBox()
Constructor

Method Detail

getTextField

public javax.swing.JTextField getTextField()
Get the Text Field

Returns:
the TextField

getListBox

public javax.swing.JList getListBox()
Get the List Box

Returns:
the ListBox

setListData

public void setListData(java.lang.Object[] values)
Set the Lists Data

Parameters:
values - the list items

setTextValue

public void setTextValue(java.lang.String value)
Set this value to the TextField and set this value as the current selected item in the ListBox

Specified by:
setTextValue in interface ReloadWidget
Parameters:
value - the value to be set

insertTextValue

public void insertTextValue(java.lang.String text)
Insert some text

Specified by:
insertTextValue in interface ReloadWidget
Parameters:
text - the text to insert

getTextValue

public java.lang.String getTextValue()
Get the Value from the TextField

Specified by:
getTextValue in interface ReloadWidget
Returns:
the text from the TextField

setMaxLength

public void setMaxLength(int maxLength)
Set the maximum allowed of digits

Specified by:
setMaxLength in interface ReloadWidget
Parameters:
maxLength - the maximum allowed digits

isSingleLine

public boolean isSingleLine()
Determine whether this widget only needs a single line to display itself

Specified by:
isSingleLine in interface ReloadWidget
Returns:
true if this widget needs only a single line to display itself, false otherwise

addDocumentListener

public void addDocumentListener(javax.swing.event.DocumentListener dl)
Add a DocumentListener to the Text Box

Specified by:
addDocumentListener in interface ReloadWidget
Parameters:
dl - the DocumentListener to add

removeDocumentListener

public void removeDocumentListener(javax.swing.event.DocumentListener dl)
Remove a DocumentListener from the Text Box

Specified by:
removeDocumentListener in interface ReloadWidget
Parameters:
dl - the DocumentListener to remove

setEnabled

public void setEnabled(boolean enabled)
Set the components enabled/disabled

Parameters:
enabled - true or false depending on whether you want to enable or disable the component

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent e)
ListSelection Listener for the Vocabulary List and update the Text Field

Specified by:
valueChanged in interface javax.swing.event.ListSelectionListener
Parameters:
e - the ListSelectionEvent

setList

public void setList(ReloadVocabularyList rvList)
Set the VocabularyList

Parameters:
rvList - the vocabulary list

destroy

public void destroy()
Destroy, remove the ReloadVocabularyListener


vocabularyListChanged

public void vocabularyListChanged(ReloadVocabularyListenerEvent event)
Update the ListBox items since the Vocabulary List has changed

Specified by:
vocabularyListChanged in interface ReloadVocabularyListener
Parameters:
event - the ReloadVocabularyListenerEvent

VdexReload 1.1.3 API