org.formaria.swing
Class List

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JList
                  org.formaria.swing.List

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ListSelectionListener, javax.swing.Scrollable, ErrorDisplay, ListenerHelper, ListHolder

Direct Known Subclasses:

CheckList

public class List
extends javax.swing.JList
implements ListHolder, ListenerHelper, javax.swing.event.ListSelectionListener, ErrorDisplay

A wrapper for the Swing List class

Copyright (c) Formaria Ltd., 2008. See license.txt for more details

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JList

javax.swing.JList.AccessibleJList, javax.swing.JList.DropLocation

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected java.lang.String	errorMessage
protected int	errorStatus
protected HandlerInvoker	invoker
protected javax.swing.DefaultListModel	listModel

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

List()
Create a new DefaultListModel and set it as the model for this component

Method Summary

void	addHandler(java.lang.Object page, java.lang.String type, java.lang.String methodName) Add an event handler response method to a component such that the page's response method is invoked when the event occurs
void	addItem(java.lang.Object obj) Add an item to the listmodel
int	getItemCount() Get the number of items in the list
java.lang.Object	getSelectedObject() Get the selected object
java.lang.Object[]	getSelectedObjects() Get the selected objects
void	paint(java.awt.Graphics g)
void	removeAll() Remove all the elements from the listmodel
void	select(int i) select the element at the specified index
void	select(java.lang.Object o) set the selected object
void	setDefaultSelection() Set the list to its default selection state
void	setDragEnabled(boolean state) Setup drag and drop support
void	setErrorMessage(java.lang.String errorMsg) Set the error message
void	setErrorStatus(int status) Set the error status
void	setRenderer(java.lang.String className)
void	setRendererClass(java.lang.String className) Set the renderer.
void	setSelectedObject(java.lang.Object o) Get the selected object
void	setSelectedObjects(java.lang.Object[] values) Set the selected objects
void	valueChanged(javax.swing.event.ListSelectionEvent evt)

Methods inherited from class javax.swing.JList

addListSelectionListener, addSelectionInterval, clearSelection, createSelectionModel, ensureIndexIsVisible, fireSelectionValueChanged, getAccessibleContext, getAnchorSelectionIndex, getCellBounds, getCellRenderer, getDragEnabled, getDropLocation, getDropMode, 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, setDropMode, 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, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, 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, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, 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, 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, isEnabled, 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 org.formaria.aria.ListHolder

getSelectedIndex, getSelectionMode

Field Detail

listModel

protected javax.swing.DefaultListModel listModel

invoker

protected HandlerInvoker invoker

errorStatus

protected int errorStatus

errorMessage

protected java.lang.String errorMessage

Constructor Detail

List

public List()

Create a new DefaultListModel and set it as the model for this component

Method Detail

setDefaultSelection

public void setDefaultSelection()

Set the list to its default selection state

Specified by:

setDefaultSelection in interface ListHolder

getSelectedObject

public java.lang.Object getSelectedObject()

Description copied from interface: ListHolder

Get the selected object

Specified by:

getSelectedObject in interface ListHolder

Returns:

the selected object in the list

getSelectedObjects

public java.lang.Object[] getSelectedObjects()

Description copied from interface: ListHolder

Get the selected objects

Specified by:

getSelectedObjects in interface ListHolder

Returns:

the selected objects in the list

setSelectedObject

public void setSelectedObject(java.lang.Object o)

Get the selected object

Specified by:

setSelectedObject in interface ListHolder

Parameters:

o - the selected object

setSelectedObjects

public void setSelectedObjects(java.lang.Object[] values)

Set the selected objects

Specified by:

setSelectedObjects in interface ListHolder

Parameters:

values - the selected object

select

public void select(java.lang.Object o)

set the selected object

Specified by:

select in interface ListHolder

Parameters:

o - the value to be selected

select

public void select(int i)

select the element at the specified index

Specified by:

select in interface ListHolder

Parameters:

i -

addItem

public void addItem(java.lang.Object obj)

Add an item to the listmodel

Specified by:

addItem in interface ListHolder

Parameters:

obj - the item to be added

getItemCount

public int getItemCount()

Description copied from interface: ListHolder

Get the number of items in the list

Specified by:

getItemCount in interface ListHolder

Returns:

the current size of the listmodel

removeAll

public void removeAll()

Remove all the elements from the listmodel

Specified by:

removeAll in interface ListHolder

Overrides:

removeAll in class java.awt.Container

addHandler

public void addHandler(java.lang.Object page,
                       java.lang.String type,
                       java.lang.String methodName)
                throws java.lang.NoSuchMethodException

Description copied from interface: ListenerHelper

Add an event handler response method to a component such that the page's response method is invoked when the event occurs

Specified by:

addHandler in interface ListenerHelper

Parameters:

page - the page containing the method

type - the type of event handler

methodName - the method to invoke

Throws:

java.lang.NoSuchMethodException - throw if the named Method cannot be found

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent evt)

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener

setDragEnabled

public void setDragEnabled(boolean state)

Setup drag and drop support

Overrides:

setDragEnabled in class javax.swing.JList

Parameters:

state - true to enable drag and drop support

setRenderer

public void setRenderer(java.lang.String className)

setRendererClass

public void setRendererClass(java.lang.String className)

Set the renderer. The renderer should be set prior to any rendering of the component.

Parameters:

className - the full clas name

paint

public void paint(java.awt.Graphics g)

Overrides:

paint in class javax.swing.JComponent

setErrorStatus

public void setErrorStatus(int status)

Set the error status

Specified by:

setErrorStatus in interface ErrorDisplay

Parameters:

status -

setErrorMessage

public void setErrorMessage(java.lang.String errorMsg)

Set the error message

Specified by:

setErrorMessage in interface ErrorDisplay

Parameters:

errorMsg - the message text