org.jboss.forge.addon.ui.context

Interface UISelection<SELECTIONTYPE>

Type Parameters:

SELECTIONTYPE - The selection type, must be common between all selections (if multiple).

All Superinterfaces:

Iterable<SELECTIONTYPE>

public interface UISelection<SELECTIONTYPE>
extends Iterable<SELECTIONTYPE>

Represents the objects with on which the UIContext is currently focused. This may be the current working directory, highlighted files, text, or other focusable items. This object and the iterator provided by this object are immutable.

Author:

Lincoln Baxter, III, George Gastaldi

Method Summary

Modifier and Type	Method and Description
SELECTIONTYPE	get() Provides the first selected element as a SELECTIONTYPE.
Optional<UIRegion<SELECTIONTYPE>>	getRegion() Returns the selected UIRegion for the first element
boolean	isEmpty() Checks if this selection is empty
int	size() Counts the elements in this selection.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

get

SELECTIONTYPE get()

Provides the first selected element as a SELECTIONTYPE. This is a convenience method to avoid iteration.

Returns:

the first element in this selection. Returns null if no selection is found

size

int size()

Counts the elements in this selection.

Returns:

the number of selected elements

isEmpty

boolean isEmpty()

Checks if this selection is empty

Returns:

true if the selection is empty, false otherwise

getRegion

Optional<UIRegion<SELECTIONTYPE>> getRegion()

Returns the selected UIRegion for the first element

Returns:

an Optional with the selected UIRegion for the UI