org.openide.explorer 6.16.1 1

org.openide.explorer.view
Class OutlineView

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JScrollPane
                  extended by org.openide.explorer.view.OutlineView
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, ScrollPaneConstants

public class OutlineView
extends JScrollPane

Explorer view displaying nodes in a tree table.

Related documentation:

Note: This API is still under development and may change even in incompatible way during its stabilization phase. The API will be finalized in NetBeans version 6.5.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JScrollPane
JScrollPane.AccessibleJScrollPane, JScrollPane.ScrollBar
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JScrollPane
columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport
 
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 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 inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
OutlineView()
          Creates a new instance of TableView
OutlineView(String nodesColumnLabel)
          Creates a new instance of TableView
 
Method Summary
 void addNotify()
          Initializes the component and lookup explorer manager.
 void addTreeExpansionListener(TreeExpansionListener l)
           
 void collapseNode(Node n)
          Collapses the tree under given node.
protected  org.netbeans.swing.outline.OutlineModel createOutlineModel(NodeTreeModel treeModel, org.netbeans.swing.outline.RowModel rowModel, String label)
          This method allows plugging own OutlineModel to the OutlineView.
 void expandNode(Node n)
          Expandes the node in the tree.
 int getAllowedDragActions()
          Actions constants comes from DnDConstants.
 int getAllowedDropActions()
          Actions constants comes from DnDConstants.
 NodePopupFactory getNodePopupFactory()
          Getter for the current popup customizer factory.
 org.netbeans.swing.outline.Outline getOutline()
          Getter for the embeded table component.
 boolean isDragSource()
          Drag support is enabled by default.
 boolean isDropTarget()
          Drop support is enabled by default.
 boolean isExpanded(Node n)
          Test whether a node is expanded in the tree or not
 boolean isPopupAllowed()
          Is it permitted to display a popup menu?
 void readSettings(Properties p, String propertyPrefix)
          Method allowing to read stored values.
 void removeNotify()
          Deinitializes listeners.
 void removeTreeExpansionListener(TreeExpansionListener l)
           
 void requestFocus()
          Requests focus for the tree component.
 boolean requestFocusInWindow()
          Requests focus for the tree component.
 void setAllowedDragActions(int actions)
          Sets allowed actions for dragging
 void setAllowedDropActions(int actions)
          Sets allowed actions for dropping.
 void setDragSource(boolean state)
          Enables/disables dragging support.
 void setDropTarget(boolean state)
          Enables/disables dropping support.
 void setNodePopupFactory(NodePopupFactory newFactory)
          Allows customization of the popup menus.
 void setPopupAllowed(boolean value)
          Enable/disable displaying popup menus on tree view items.
 void setProperties(Node.Property[] newProperties)
           
 void writeSettings(Properties p, String propertyPrefix)
          Method allowing to store customization values.
 
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 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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, paint, 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 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, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OutlineView

public OutlineView()
Creates a new instance of TableView


OutlineView

public OutlineView(String nodesColumnLabel)
Creates a new instance of TableView

Method Detail

createOutlineModel

protected org.netbeans.swing.outline.OutlineModel createOutlineModel(NodeTreeModel treeModel,
                                                                     org.netbeans.swing.outline.RowModel rowModel,
                                                                     String label)
This method allows plugging own OutlineModel to the OutlineView. You can override it and create different model in the subclass.


requestFocus

public void requestFocus()
Requests focus for the tree component. Overrides superclass method.

Overrides:
requestFocus in class JComponent

requestFocusInWindow

public boolean requestFocusInWindow()
Requests focus for the tree component. Overrides superclass method.

Overrides:
requestFocusInWindow in class JComponent

getOutline

public org.netbeans.swing.outline.Outline getOutline()
Getter for the embeded table component.


isPopupAllowed

public boolean isPopupAllowed()
Is it permitted to display a popup menu?

Returns:
true if so

setProperties

public void setProperties(Node.Property[] newProperties)

setPopupAllowed

public void setPopupAllowed(boolean value)
Enable/disable displaying popup menus on tree view items. Default is enabled.

Parameters:
value - true to enable

addNotify

public void addNotify()
Initializes the component and lookup explorer manager.

Overrides:
addNotify in class JComponent

readSettings

public void readSettings(Properties p,
                         String propertyPrefix)
Method allowing to read stored values. The stored values should be only those that the user has customized, it does not make sense to store the values that were set using the initialization code because the initialization code can be run in the same way after restart.


writeSettings

public void writeSettings(Properties p,
                          String propertyPrefix)
Method allowing to store customization values. The stored values should be only those that the user has customized, it does not make sense to store the values that were set using the initialization code because the initialization code can be run in the same way after restart.


setNodePopupFactory

public void setNodePopupFactory(NodePopupFactory newFactory)
Allows customization of the popup menus.


getNodePopupFactory

public NodePopupFactory getNodePopupFactory()
Getter for the current popup customizer factory.


removeNotify

public void removeNotify()
Deinitializes listeners.

Overrides:
removeNotify in class JComponent

isDragSource

public boolean isDragSource()
Drag support is enabled by default.

Returns:
true if dragging from the view is enabled, false otherwise.

setDragSource

public void setDragSource(boolean state)
Enables/disables dragging support.

Parameters:
state - true enables dragging support, false disables it.

isDropTarget

public boolean isDropTarget()
Drop support is enabled by default.

Returns:
true if dropping to the view is enabled, false otherwise

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

addTreeExpansionListener

public void addTreeExpansionListener(TreeExpansionListener l)

removeTreeExpansionListener

public void removeTreeExpansionListener(TreeExpansionListener l)

collapseNode

public void collapseNode(Node n)
Collapses the tree under given node.

Parameters:
n - node to collapse

expandNode

public void expandNode(Node n)
Expandes the node in the tree.

Parameters:
n - node

isExpanded

public boolean isExpanded(Node n)
Test whether a node is expanded in the tree or not

Parameters:
n - the node to test
Returns:
true if the node is expanded

org.openide.explorer 6.16.1 1

Built on May 31 2009.  |  Portions Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.