Eclipse Platform
Release 3.7

org.eclipse.jface.viewers
Interface IStructuredSelection

All Superinterfaces:
ISelection
All Known Subinterfaces:
ITreeSelection
All Known Implementing Classes:
StructuredSelection, TreeSelection

public interface IStructuredSelection
extends ISelection

A selection containing elements.


Method Summary
 Object getFirstElement()
          Returns the first element in this selection, or null if the selection is empty.
 Iterator iterator()
          Returns an iterator over the elements of this selection.
 int size()
          Returns the number of elements selected in this selection.
 Object[] toArray()
          Returns the elements in this selection as an array.
 List toList()
          Returns the elements in this selection as a List.
 
Methods inherited from interface org.eclipse.jface.viewers.ISelection
isEmpty
 

Method Detail

getFirstElement

Object getFirstElement()
Returns the first element in this selection, or null if the selection is empty.

Returns:
an element, or null if none

iterator

Iterator iterator()
Returns an iterator over the elements of this selection.

Returns:
an iterator over the selected elements

size

int size()
Returns the number of elements selected in this selection.

Returns:
the number of elements selected

toArray

Object[] toArray()
Returns the elements in this selection as an array.

Returns:
the selected elements as an array

toList

List toList()
Returns the elements in this selection as a List. Note In the default implementation of toList() in StructuredSelection the returned list is not a copy of the elements of the receiver and modifying it will modify the contents of the selection.

Returns:
the selected elements as a list

Eclipse Platform
Release 3.7

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.