com.retek.commons.gui.widget
Class RList

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JList
                  extended bycom.retek.commons.gui.widget.RList
All Implemented Interfaces:
javax.accessibility.Accessible, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.event.MouseListener, javax.swing.Scrollable, java.io.Serializable

public class RList
extends javax.swing.JList
implements java.awt.event.MouseListener

This class extends RList to add on generic useful functionality for RCOM.

Retek Inc. Copyright (c) 2002

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JList
javax.swing.JList.AccessibleJList
 
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
static java.lang.String VALUE_SELECTED
           
 
Fields inherited from class javax.swing.JList
HORIZONTAL_WRAP, VERTICAL, VERTICAL_WRAP
 
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
RList()
          Returns new RList object with default list model assigned.
 
Method Summary
 void addItems(java.util.Collection collection)
          Adds a collection of objects to the list.
 void addItems(java.lang.Object[] array)
          Adds an array of objects to the list.
 void addREventListener(REventListener listener)
          Adds a REventListener to the REventListener list.
 java.util.List getItems()
          Retrieves all the items in the list.
 void mouseClicked(java.awt.event.MouseEvent mouseEvent)
          Implement the mouse listener interface 'mouse clicked' method.
 void mouseEntered(java.awt.event.MouseEvent event)
          Empty implementation of the mouse listener interface method.
 void mouseExited(java.awt.event.MouseEvent event)
          Empty implementation of the mouse listener interface method.
 void mousePressed(java.awt.event.MouseEvent event)
          Empty implementation of the mouse listener interface method.
 void mouseReleased(java.awt.event.MouseEvent event)
          Empty implementation of the mouse listener interface method.
 void notifyREventListeners(RActionEvent event)
          Notifies all listeners of an action event.
 void notifyREventListeners(RErrorEvent event)
          Notifies all listeners of an error event.
 void removeAllREventListeners()
          Removes a REventListener from the REventListener list.
 void removeItems()
          Removes all items from the list.
 void removeItems(java.util.Collection collection)
          Removes a collection of objects from the list.
 void removeItems(java.lang.Object[] array)
          Removes an array of objects from the list.
 void removeREventListener(REventListener listener)
          Removes a REventListener from the REventListener list.
 void removeSelectedValues()
          Removes all currently selected values from the list.'
 void setItems(java.util.Collection collection)
          Sets a collection of objects in the list.
 void setSelectedValues(java.util.Collection values)
          Selects all items in the collection passed in.
 void setSingleSelectionMode()
          Assigns single selection mode to the list.
 void sortItems()
          Sorts item by toString() method
 
Methods inherited from class javax.swing.JList
addListSelectionListener, addSelectionInterval, clearSelection, createSelectionModel, ensureIndexIsVisible, fireSelectionValueChanged, getAccessibleContext, getAnchorSelectionIndex, getCellBounds, getCellRenderer, getDragEnabled, getFirstVisibleIndex, getFixedCellHeight, getFixedCellWidth, getLastVisibleIndex, getLayoutOrientation, getLeadSelectionIndex, getListSelectionListeners, getMaxSelectionIndex, getMinSelectionIndex, getModel, getNextMatch, getPreferredScrollableViewportSize, getPrototypeCellValue, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedIndex, getSelectedIndices, getSelectedValue, getSelectedValues, getSelectionBackground, getSelectionForeground, getSelectionMode, getSelectionModel, getToolTipText, getUI, getUIClassID, getValueIsAdjusting, getVisibleRowCount, indexToLocation, isSelectedIndex, isSelectionEmpty, locationToIndex, paramString, removeListSelectionListener, removeSelectionInterval, setCellRenderer, setDragEnabled, setFixedCellHeight, setFixedCellWidth, setLayoutOrientation, setListData, setListData, setModel, setPrototypeCellValue, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectionBackground, setSelectionForeground, setSelectionInterval, setSelectionMode, setSelectionModel, setUI, setValueIsAdjusting, setVisibleRowCount, 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, 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, setEnabled, 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

VALUE_SELECTED

public static java.lang.String VALUE_SELECTED
Constructor Detail

RList

public RList()
Returns new RList object with default list model assigned.

Method Detail

setSingleSelectionMode

public void setSingleSelectionMode()
Assigns single selection mode to the list.


setItems

public void setItems(java.util.Collection collection)
Sets a collection of objects in the list. This method first removes all previous objects before assigning the new objects. Additionally, it uses toString() to determine what will be displayed.

Parameters:
collection - A collection of objects to display in the list.

addItems

public void addItems(java.lang.Object[] array)
Adds an array of objects to the list. Duplicate objects will not be added.

Parameters:
array - The array of objects to add to the list.

addItems

public void addItems(java.util.Collection collection)
Adds a collection of objects to the list. Duplicate objects will not be added.

Parameters:
collection - The collection of objects to add to the list.

getItems

public java.util.List getItems()
Retrieves all the items in the list.

Returns:
A list of all items within the list.

setSelectedValues

public void setSelectedValues(java.util.Collection values)
Selects all items in the collection passed in. If an item is in the collection, but not this list, it is ignored.

Parameters:
values - A collection of values to be selected.

removeSelectedValues

public void removeSelectedValues()
Removes all currently selected values from the list.'


removeItems

public void removeItems()
Removes all items from the list.


removeItems

public void removeItems(java.lang.Object[] array)
Removes an array of objects from the list.

Parameters:
array - The array of objects to remove from the list.

removeItems

public void removeItems(java.util.Collection collection)
Removes a collection of objects from the list.

Parameters:
collection - The collection of objects to remove from the list.

sortItems

public void sortItems()
Sorts item by toString() method


mousePressed

public void mousePressed(java.awt.event.MouseEvent event)
Empty implementation of the mouse listener interface method.

Specified by:
mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent event)
Empty implementation of the mouse listener interface method.

Specified by:
mouseReleased in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent event)
Empty implementation of the mouse listener interface method.

Specified by:
mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent event)
Empty implementation of the mouse listener interface method.

Specified by:
mouseExited in interface java.awt.event.MouseListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent mouseEvent)
Implement the mouse listener interface 'mouse clicked' method. If the time event is identical to the last event, then do nothing. If a double click occurs within a row, the table listener is informed. If a single click occurs within a column header, the table is sorted on that column. If the same column is clicked again, the sort order is reversed.

Specified by:
mouseClicked in interface java.awt.event.MouseListener

addREventListener

public void addREventListener(REventListener listener)
Adds a REventListener to the REventListener list.

Parameters:
listener - The REventListener to add.

removeREventListener

public void removeREventListener(REventListener listener)
Removes a REventListener from the REventListener list.

Parameters:
listener - The REventListener to remove.

removeAllREventListeners

public void removeAllREventListeners()
Removes a REventListener from the REventListener list.


notifyREventListeners

public void notifyREventListeners(RActionEvent event)
Notifies all listeners of an action event.

Parameters:
event - An RActionEvent object containing details about the event.

notifyREventListeners

public void notifyREventListeners(RErrorEvent event)
Notifies all listeners of an error event.

Parameters:
event - An RErrorEvent object containing details about the event.


Copyright © 2004 Retek Inc. All Rights Reserved. - Generated at Fri, 10/22/2004 07:28