ListView (Explorer & Property Sheet API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JScrollPane
      - org.openide.explorer.view.ListView

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

IconView, ListTableView
```
public class ListView
extends javax.swing.JScrollPane
implements java.io.Externalizable
```
Explorer view to display items in a list.
This class is a view to use it properly you need to add it into a component which implements ExplorerManager.Provider. Good examples of that can be found in ExplorerUtils. Then just use ExplorerManager.Provider.getExplorerManager() call to get the ExplorerManager and control its state.

There can be multiple views under one container implementing ExplorerManager.Provider. Select from range of predefined ones or write your own:
- BeanTreeView - shows a tree of nodes
- ContextTreeView - shows a tree of nodes without leaf nodes
- ListView - shows a list of nodes
- IconView - shows a rows of nodes with bigger icons
- ChoiceView - creates a combo box based on the explored nodes
- TreeTableView - shows tree of nodes together with a set of their Node.Property
- MenuView - can create a JMenu structure based on structure of Nodes
All of these views use ExplorerManager.find(java.awt.Component) to walk up the AWT hierarchy and locate the ExplorerManager to use as a controller. They attach as listeners to it and also call its setter methods to update the shared state based on the user action. Not all views make sense together, but for example ContextTreeView and ListView were designed to complement themselves and behaves like windows explorer. The PropertySheetView for example should be able to work with any other view.
See Also:

Serialized Form

Nested Class Summary
- 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
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class javax.swing.JScrollPane
  javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar

Field Summary

Fields
Modifier and Type Field Description

protected javax.swing.JList list
The actual JList list

protected NodeListModel model
model to use
- Fields inherited from class java.awt.Component
  accessibleContext, 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
- Fields inherited from class javax.swing.JComponent
  listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
- Fields inherited from class javax.swing.JScrollPane
  columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport
- Fields inherited from interface javax.swing.ScrollPaneConstants
  COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Fields
Modifier and Type	Field	Description
`protected javax.swing.JList`	`list`	The actual JList list
`protected NodeListModel`	`model`	model to use

Constructor Summary

Constructors
Constructor Description

ListView()
Default constructor.

Constructors
Constructor	Description
`ListView()`	Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addNotify()`
`protected javax.swing.JList`	`createList()`	Creates the list that will display the data.
`protected NodeListModel`	`createModel()`	Allows subclasses to change the default model used for the list.
`void`	`doLayout()`
`int`	`getAllowedDragActions()`	Actions constants comes from `DnDConstants`.
`int`	`getAllowedDropActions()`	Actions constants comes from `DnDConstants`.
`java.awt.event.ActionListener`	`getDefaultProcessor()`	Get the current processor for default actions.
`java.awt.Dimension`	`getPreferredSize()`
`int`	`getSelectionMode()`	Get the selection mode.
`boolean`	`isDragSource()`
`boolean`	`isDropTarget()`
`boolean`	`isPopupAllowed()`	Test whether display of a popup menu is enabled.
`boolean`	`isShowParentNode()`	Is parent node (e.g.
`boolean`	`isTraversalAllowed()`	Test whether hierarchy traversal shortcuts are permitted.
`void`	`paint(java.awt.Graphics g)`
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`removeNotify()`	Removes listeners.
`void`	`requestFocus()`
`boolean`	`requestFocusInWindow()`
`protected boolean`	`selectionAccept(org.openide.nodes.Node[] nodes)`	Called when explorer manager is about to change the current selection.
`protected void`	`selectionChanged(org.openide.nodes.Node[] nodes, ExplorerManager em)`	Called when the list changed selection and the explorer manager should be updated.
`void`	`setAllowedDragActions(int actions)`	Sets allowed actions for dragging
`void`	`setAllowedDropActions(int actions)`	Sets allowed actions for dropping.
`void`	`setDefaultProcessor(java.awt.event.ActionListener value)`	Set a new processor for default actions.
`void`	`setDragSource(boolean state)`	Enables/disables dragging support.
`void`	`setDropTarget(boolean state)`	Enables/disables dropping support.
`void`	`setPopupAllowed(boolean value)`	Enable/disable displaying popup menus on list view items.
`void`	`setSelectionMode(int selectionMode)`	Set whether single-item or multiple-item selections are allowed.
`void`	`setShowParentNode(boolean show)`	Shall the first node in the list be ".." representing currently explored context? By default it is not, but if you want to simplify the navigation in the `Node` hierarchy, you can turn this property on.
`void`	`setTraversalAllowed(boolean value)`	Enable/disable hierarchy traversal using `CTRL+click` (down) and `Backspace` (up), default is enabled.
`protected void`	`showSelection(int[] indexes)`	Shows selection.
`protected void`	`validateTree()`
`void`	`writeExternal(java.io.ObjectOutput out)`

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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, 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, transferFocusDownCycle, validate

Methods inherited from class javax.swing.JComponent
addAncestorListener, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, 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 javax.swing.JScrollPane
createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, updateUI

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - list
```
protected transient javax.swing.JList list
```
    The actual JList list
  - model
```
protected transient NodeListModel model
```
    model to use
- Constructor Detail
  - ListView
```
public ListView()
```
    Default constructor.
- Method Detail
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - isPopupAllowed
```
public boolean isPopupAllowed()
```
    Test whether display of a popup menu is enabled.
    
    Returns:
    
    true if so
  - setPopupAllowed
```
public void setPopupAllowed(boolean value)
```
    Enable/disable displaying popup menus on list view items. Default is enabled.
    
    Parameters:
    
    value - true to enable
  - isTraversalAllowed
```
public boolean isTraversalAllowed()
```
    Test whether hierarchy traversal shortcuts are permitted.
    
    Returns:
    
    true if so
  - setTraversalAllowed
```
public void setTraversalAllowed(boolean value)
```
    Enable/disable hierarchy traversal using CTRL+click (down) and Backspace (up), default is enabled.
    
    Parameters:
    
    value - true to enable
  - isShowParentNode
```
public boolean isShowParentNode()
```
    Is parent node (e.g. explored context shown)?
    
    Returns:
    
    true or false. Default is false.
    
    Since:
    
    6.28
  - setShowParentNode
```
public void setShowParentNode(boolean show)
```
    Shall the first node in the list be ".." representing currently explored context? By default it is not, but if you want to simplify the navigation in the Node hierarchy, you can turn this property on.
    
    Parameters:
    
    show - true to show the "..", false to not to do so
    
    Since:
    
    6.28
  - getDefaultProcessor
```
public java.awt.event.ActionListener getDefaultProcessor()
```
    Get the current processor for default actions. If not null, double-clicks or pressing Enter on items in the view will not perform the default action on the selected node; rather the processor will be notified about the event.
    
    Returns:
    
    the current default-action processor, or null
  - setDefaultProcessor
```
public void setDefaultProcessor(java.awt.event.ActionListener value)
```
    Set a new processor for default actions.
    
    Parameters:
    
    value - the new default-action processor, or null to restore use of the selected node's declared default action
    
    See Also:
    
    getDefaultProcessor()
  - setSelectionMode
```
public void setSelectionMode(int selectionMode)
```
    Set whether single-item or multiple-item selections are allowed.
    
    Parameters:
    
    selectionMode - one of ListSelectionModel.SINGLE_SELECTION, ListSelectionModel.SINGLE_INTERVAL_SELECTION, or ListSelectionModel.MULTIPLE_INTERVAL_SELECTION
    
    See Also:
    
    ListSelectionModel.setSelectionMode(int)
  - getSelectionMode
```
public int getSelectionMode()
```
    Get the selection mode.
    
    Returns:
    
    the mode
    
    See Also:
    
    setSelectionMode(int)
  - isDragSource
```
public boolean isDragSource()
```
    Returns:
    
    true if dragging from the view is enabled, false otherwise.
    Drag support is disabled by default.
  - setDragSource
```
public void setDragSource(boolean state)
```
    Enables/disables dragging support.
    
    Parameters:
    
    state - true enables dragging support, false disables it.
  - isDropTarget
```
public boolean isDropTarget()
```
    Returns:
    
    true if dropping to the view is enabled, false otherwise
    Drop support is disabled by default.
  - setDropTarget
```
public void setDropTarget(boolean state)
```
    Enables/disables dropping support.
    
    Parameters:
    
    state - true means drops into view are allowed, false forbids any drops into this view.
  - getAllowedDragActions
```
public int getAllowedDragActions()
```
    Actions constants comes from DnDConstants. All actions (copy, move, link) are allowed by default.
    
    Returns:
    
    int representing set of actions which are allowed when dragging from asociated component.
  - setAllowedDragActions
```
public void setAllowedDragActions(int actions)
```
    Sets allowed actions for dragging
    
    Parameters:
    
    actions - new drag actions, using DnDConstants
  - getAllowedDropActions
```
public int getAllowedDropActions()
```
    Actions constants comes from DnDConstants. All actions are allowed by default.
    
    Returns:
    
    int representing set of actions which are allowed when dropping into the asociated component.
  - setAllowedDropActions
```
public void setAllowedDropActions(int actions)
```
    Sets allowed actions for dropping.
    
    Parameters:
    
    actions - new allowed drop actions, using DnDConstants
  - createList
```
protected javax.swing.JList createList()
```
    Creates the list that will display the data.
  - createModel
```
protected NodeListModel createModel()
```
    Allows subclasses to change the default model used for the list.
  - selectionChanged
```
protected void selectionChanged(org.openide.nodes.Node[] nodes,
                                ExplorerManager em)
                         throws java.beans.PropertyVetoException
```
    Called when the list changed selection and the explorer manager should be updated.
    
    Parameters:
    
    nodes - list of nodes that should be selected
    
    em - explorer manager
    
    Throws:
    
    java.beans.PropertyVetoException - if the manager does not allow the selection
  - selectionAccept
```
protected boolean selectionAccept(org.openide.nodes.Node[] nodes)
```
    Called when explorer manager is about to change the current selection. The view can forbid the change if it is not able to display such selection.
    
    Parameters:
    
    nodes - the nodes to select
    
    Returns:
    
    false if the view is not able to change the selection
  - showSelection
```
protected void showSelection(int[] indexes)
```
    Shows selection.
    
    Parameters:
    
    indexes - indexes of objects to select
  - paint
```
public void paint(java.awt.Graphics g)
```
    Overrides:
    
    paint in class javax.swing.JComponent
  - validateTree
```
protected void validateTree()
```
    Overrides:
    
    validateTree in class java.awt.Container
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize()
```
    Overrides:
    
    getPreferredSize in class javax.swing.JComponent
  - doLayout
```
public void doLayout()
```
    Overrides:
    
    doLayout in class java.awt.Container
  - addNotify
```
public void addNotify()
```
    Overrides:
    
    addNotify in class javax.swing.JComponent
  - removeNotify
```
public void removeNotify()
```
    Removes listeners.
    
    Overrides:
    
    removeNotify in class javax.swing.JComponent
  - requestFocus
```
public void requestFocus()
```
    Overrides:
    
    requestFocus in class javax.swing.JComponent
  - requestFocusInWindow
```
public boolean requestFocusInWindow()
```
    Overrides:
    
    requestFocusInWindow in class javax.swing.JComponent

Class ListView

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Fields inherited from class javax.swing.JComponent

Fields inherited from class javax.swing.JScrollPane

Fields inherited from interface javax.swing.ScrollPaneConstants

Constructor Summary

Method Summary

Methods inherited from class java.awt.Component

Methods inherited from class java.awt.Container

Methods inherited from class javax.swing.JComponent

Methods inherited from class javax.swing.JScrollPane

Methods inherited from class java.lang.Object

Field Detail

list

model

Constructor Detail

ListView

Method Detail

writeExternal

readExternal

isPopupAllowed

setPopupAllowed

isTraversalAllowed

setTraversalAllowed

isShowParentNode

setShowParentNode

getDefaultProcessor

setDefaultProcessor

setSelectionMode

getSelectionMode

isDragSource

setDragSource

isDropTarget

setDropTarget

getAllowedDragActions

setAllowedDragActions

getAllowedDropActions

setAllowedDropActions

createList

createModel

selectionChanged

selectionAccept

showSelection

paint

validateTree

getPreferredSize

doLayout

addNotify

removeNotify

requestFocus

requestFocusInWindow