javax.swing.event

## Class TreeSelectionEvent

- java.lang.Object
- - java.util.EventObject
  - - javax.swing.event.TreeSelectionEvent

- All Implemented Interfaces:
    Serializable

      public class TreeSelectionEvent
      extends EventObject

  An event that characterizes a change in the current selection. The change is based on any number of paths. TreeSelectionListeners will generally query the source of the event for the new selected status of each potentially changed row.

  Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the `java.beans` package. Please see `XMLEncoder`.

  See Also:
    `TreeSelectionListener`, `TreeSelectionModel`

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected boolean[]` | `areNew` For each path identifies if that path is in fact new.
    `protected TreePath` | `newLeadSelectionPath` leadSelectionPath after the paths changed, may be null.
    `protected TreePath` | `oldLeadSelectionPath` leadSelectionPath before the paths changed, may be null.
    `protected TreePath[]` | `paths` Paths this event represents.

    - ### Fields inherited from class java.util.EventObject

      `source`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `TreeSelectionEvent(Object source, TreePath[] paths, boolean[] areNew, TreePath oldLeadSelectionPath, TreePath newLeadSelectionPath)` Represents a change in the selection of a TreeSelectionModel.
    `TreeSelectionEvent(Object source, TreePath path, boolean isNew, TreePath oldLeadSelectionPath, TreePath newLeadSelectionPath)` Represents a change in the selection of a TreeSelectionModel.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Object` | `cloneWithSource(Object newSource)` Returns a copy of the receiver, but with the source being newSource.
    `TreePath` | `getNewLeadSelectionPath()` Returns the current lead path.
    `TreePath` | `getOldLeadSelectionPath()` Returns the path that was previously the lead path.
    `TreePath` | `getPath()` Returns the first path element.
    `TreePath[]` | `getPaths()` Returns the paths that have been added or removed from the selection.
    `boolean` | `isAddedPath()` Returns whether the path identified by `getPath` was added to the selection.
    `boolean` | `isAddedPath(int index)` Returns whether the path at `getPaths()[index]` was added to the selection.
    `boolean` | `isAddedPath(TreePath path)` Returns whether the specified path was added to the selection.

    - ### Methods inherited from class java.util.EventObject

      `getSource, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### paths

          protected TreePath[] paths

      Paths this event represents.

    - #### areNew

          protected boolean[] areNew

      For each path identifies if that path is in fact new.

    - #### oldLeadSelectionPath

          protected TreePath oldLeadSelectionPath

      leadSelectionPath before the paths changed, may be null.

    - #### newLeadSelectionPath

          protected TreePath newLeadSelectionPath

      leadSelectionPath after the paths changed, may be null.

  - ### Constructor Detail

    - #### TreeSelectionEvent

          public TreeSelectionEvent(Object source,
                            TreePath[] paths,
                            boolean[] areNew,
                            TreePath oldLeadSelectionPath,
                            TreePath newLeadSelectionPath)

      Represents a change in the selection of a TreeSelectionModel. paths identifies the paths that have been either added or removed from the selection.
      Parameters:
        `source` - source of event
        `paths` - the paths that have changed in the selection

    - #### TreeSelectionEvent

          public TreeSelectionEvent(Object source,
                            TreePath path,
                            boolean isNew,
                            TreePath oldLeadSelectionPath,
                            TreePath newLeadSelectionPath)

      Represents a change in the selection of a TreeSelectionModel. path identifies the path that have been either added or removed from the selection.
      Parameters:
        `source` - source of event
        `path` - the path that has changed in the selection
        `isNew` - whether or not the path is new to the selection, false means path was removed from the selection.

  - ### Method Detail

    - #### getPaths

          public TreePath[] getPaths()

      Returns the paths that have been added or removed from the selection.

    - #### getPath

          public TreePath getPath()

      Returns the first path element.

    - #### isAddedPath

          public boolean isAddedPath()

      Returns whether the path identified by `getPath` was added to the selection. A return value of `true` indicates the path identified by `getPath` was added to the selection. A return value of `false` indicates `getPath` was selected, but is no longer selected.
      Returns:
        `true` if `getPath` was added to the selection, `false` otherwise

    - #### isAddedPath

          public boolean isAddedPath(TreePath path)

      Returns whether the specified path was added to the selection. A return value of `true` indicates the path identified by `path` was added to the selection. A return value of `false` indicates `path` is no longer selected. This method is only valid for the paths returned from `getPaths()`; invoking with a path not included in `getPaths()` throws an `IllegalArgumentException`.
      Parameters:
        `path` - the path to test
      Returns:
        `true` if `path` was added to the selection, `false` otherwise
      Throws:
        `IllegalArgumentException` - if `path` is not contained in `getPaths`
      See Also:
        `getPaths()`

    - #### isAddedPath

          public boolean isAddedPath(int index)

      Returns whether the path at `getPaths()[index]` was added to the selection. A return value of `true` indicates the path was added to the selection. A return value of `false` indicates the path is no longer selected.
      Parameters:
        `index` - the index of the path to test
      Returns:
        `true` if the path was added to the selection, `false` otherwise
      Throws:
        `IllegalArgumentException` - if index is outside the range of `getPaths`
      Since:
        1.3
      See Also:
        `getPaths()`

    - #### getOldLeadSelectionPath

          public TreePath getOldLeadSelectionPath()

      Returns the path that was previously the lead path.

    - #### getNewLeadSelectionPath

          public TreePath getNewLeadSelectionPath()

      Returns the current lead path.

    - #### cloneWithSource

          public Object cloneWithSource(Object newSource)

      Returns a copy of the receiver, but with the source being newSource.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2019, Oracle and/or its affiliates. All rights reserved.