public class NiceList
extends javax.swing.JList
NiceListRenderer
, which provides several facilities for a specialized checkbox list with inline descriptions.
You will generally want to associate this list with an instance of NiceListRenderer
by calling JList.setCellRenderer( ListCellRenderer )
. If the renderer is anything other than a NiceListRenderer
, this implementation will never fire any NiceListActionEvent
s.
This implementation is mainly concerned with adapting various mouse and key events on the list to NiceListActionEvent
s.
javax.swing.JList.AccessibleJList, javax.swing.JList.DropLocation
javax.swing.JComponent.AccessibleJComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
NiceList() |
Modifier and Type | Method and Description |
---|---|
void |
addDoubleClickActionListener(java.awt.event.ActionListener listener)
Adds an action listener.
|
void |
addListActionListener(NiceListActionListener listener)
Adds a listener to the list.
|
protected void |
fireCheckBoxAction(int row)
Fires an event of type
NiceListActionEvent.Type.CHECKBOX to all registered listeners. |
protected void |
fireHyperLinkAction(int row)
Fires an event of type
NiceListActionEvent.Type.HYPERLINK to all registered listeners. |
protected void |
fireSecondaryHyperLinkAction(int row)
Fires an event of type
NiceListActionEvent.Type.HYPERLINK to all registered listeners. |
java.awt.Dimension |
getPreferredScrollableViewportSize()
Override to return the correct size of visible row count.
|
boolean |
isFireCheckboxActionOnDoubleClick()
Returns whether double click on a list item will fire a checkbox event.
|
boolean |
isFireCheckboxActionOnSelectionChanged()
Returns true if this list is configured to fire checkbox action events when an item in the list is selected.
|
void |
removeDoubleClickActionListener(java.awt.event.ActionListener listener)
Removes a double click action listener previously registered with
removeDoubleClickActionListener(ActionListener) . |
void |
removeListActionListener(NiceListActionListener listener)
Removes a listener from the list.
|
void |
setFireCheckboxActionOnDoubleClick(boolean toggleOnDoubleClick)
Sets whether a double click on an item in the list should automatically fire a
checkbox event to registered niceListActionListeners . |
void |
setFireCheckboxActionOnSelectionChanged(boolean fire)
Sets whether this list will fire NiceListActionEvent.Type.CHECKBOX events when an item in the list is selected.
|
addListSelectionListener, addSelectionInterval, clearSelection, createSelectionModel, ensureIndexIsVisible, fireSelectionValueChanged, getAccessibleContext, getAnchorSelectionIndex, getCellBounds, getCellRenderer, getDragEnabled, getDropLocation, getDropMode, getFirstVisibleIndex, getFixedCellHeight, getFixedCellWidth, getLastVisibleIndex, getLayoutOrientation, getLeadSelectionIndex, getListSelectionListeners, getMaxSelectionIndex, getMinSelectionIndex, getModel, getNextMatch, getPrototypeCellValue, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedIndex, getSelectedIndices, getSelectedValue, getSelectedValues, getSelectedValuesList, getSelectionBackground, getSelectionForeground, getSelectionMode, getSelectionModel, getToolTipText, getUI, getUIClassID, getValueIsAdjusting, getVisibleRowCount, indexToLocation, isSelectedIndex, isSelectionEmpty, locationToIndex, paramString, removeListSelectionListener, removeSelectionInterval, setCellRenderer, setDragEnabled, setDropMode, setFixedCellHeight, setFixedCellWidth, setLayoutOrientation, setListData, setListData, setModel, setPrototypeCellValue, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectionBackground, setSelectionForeground, setSelectionInterval, setSelectionMode, setSelectionModel, setUI, setValueIsAdjusting, setVisibleRowCount, updateUI
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, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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
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, transferFocusDownCycle, validate, validateTree
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, transferFocusBackward, transferFocusUpCycle
public void setFireCheckboxActionOnDoubleClick(boolean toggleOnDoubleClick)
checkbox
event to registered niceListActionListeners
.
By default, this property is false.
Note that setting this property does not prevent double click events from being fired to registered actionListeners
.
toggleOnDoubleClick
- if true fire checkbox events when a double click event occurs.public boolean isFireCheckboxActionOnDoubleClick()
public void setFireCheckboxActionOnSelectionChanged(boolean fire)
fire
- if true, selection change events will trigger checkbox action events.public boolean isFireCheckboxActionOnSelectionChanged()
public final void addDoubleClickActionListener(java.awt.event.ActionListener listener)
listener
- a listener to register. Must not be null.public final void removeDoubleClickActionListener(java.awt.event.ActionListener listener)
removeDoubleClickActionListener(ActionListener)
.listener
- the listener to remove.public final void addListActionListener(NiceListActionListener listener)
listener
- a listener. Must not be null.public final void removeListActionListener(NiceListActionListener listener)
listener
- a listener.protected final void fireCheckBoxAction(int row)
NiceListActionEvent.Type.CHECKBOX
to all registered listeners.row
- the row to fire the event on.protected final void fireHyperLinkAction(int row)
NiceListActionEvent.Type.HYPERLINK
to all registered listeners.row
- the row to fire the event on.protected final void fireSecondaryHyperLinkAction(int row)
NiceListActionEvent.Type.HYPERLINK
to all registered listeners.row
- the row to fire the event on.public java.awt.Dimension getPreferredScrollableViewportSize()
getPreferredScrollableViewportSize
in interface javax.swing.Scrollable
getPreferredScrollableViewportSize
in class javax.swing.JList