libGDX 1.14.2 · com.badlogic.gdx.scenes.scene2d.utils.Selection

Modifier and Type	Field and Description
private Actor	actor
pack-priv boolean	isDisabled
pack-priv T	lastSelected
pack-priv boolean	multiple
private final OrderedSet<T>	old
private boolean	programmaticChangeEvents
pack-priv boolean	required
pack-priv final OrderedSet<T>	selected
private boolean	toggle

Access	Constructor and Description
public	Selection()

Method Summary

Modifier and Type	Method and Description
public void	add(T item) Adds the item to the selection.
public void	addAll(Array<T> items)
protected void	changed() Called after the selection changes.
public void	choose(T item) Selects or deselects the specified item based on how the selection is configured, whether ctrl is currently pressed, etc. This is typically invoked by user interaction.
pack-priv void	cleanup()
public void	clear()
public boolean	contains(T May be null (returns false). item)
public boolean	Returns: true if the change should be undone. fireChangeEvent() Fires a change event on the selection's actor, if any.
public T	first() Returns the first selected item, or null.
public T	getLastSelected() Makes a best effort to return the last item selected, else returns an arbitrary item or null if the selection is empty.
public boolean	getMultiple()
public boolean	getProgrammaticChangeEvents()
public boolean	getRequired()
public boolean	getToggle()
public boolean	hasItems() Deprecated Use `notEmpty()`.
public boolean	isDisabled() Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.isDisabled.
public boolean	isEmpty()
public OrderedSet<T>	items()
public Iterator<T>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public boolean	notEmpty()
public void	remove(T item)
public void	removeAll(Array<T> items)
pack-priv void	revert()
public void	set(T item) Sets the selection to only the specified item.
public void	setActor(Actor An actor to fire `ChangeEvent` on when the selection changes, or null. actor)
public void	setAll(Array<T> items)
public void	setDisabled(boolean isDisabled) Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.setDisabled. If true, prevents `choose(Object)` from changing the selection.
public void	setMultiple(boolean multiple) If true, allows `choose(Object)` to select multiple items.
public void	setProgrammaticChangeEvents(boolean programmaticChangeEvents) If false, only `choose(Object)` will fire a change event.
public void	setRequired(boolean required) If true, prevents `choose(Object)` from selecting none.
public void	setToggle(boolean toggle) If true, prevents `choose(Object)` from clearing the selection.
public int	size()
pack-priv void	snapshot()
public Array<T>	toArray()
public Array<T>	toArray(Array<T> array)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

actor	back to summary
private Actor actor Annotations @Null

isDisabled	back to summary
pack-priv boolean isDisabled

lastSelected	back to summary
pack-priv T lastSelected Annotations @Null

multiple	back to summary
pack-priv boolean multiple

old	back to summary
private final OrderedSet<T> old

programmaticChangeEvents	back to summary
private boolean programmaticChangeEvents

required	back to summary
pack-priv boolean required

selected	back to summary
pack-priv final OrderedSet<T> selected

toggle	back to summary
private boolean toggle

Selection	back to summary
public Selection()

Method Detail

add	back to summary
public void add(T item) Adds the item to the selection.

addAll	back to summary
public void addAll(Array<T> items)

changed	back to summary
protected void changed() Called after the selection changes. The default implementation does nothing.

choose	back to summary
public void choose(T item) Selects or deselects the specified item based on how the selection is configured, whether ctrl is currently pressed, etc. This is typically invoked by user interaction.

cleanup	back to summary
pack-priv void cleanup()

clear	back to summary
public void clear()

contains	back to summary
public boolean contains(T item) Parameters item:T May be null (returns false).

fireChangeEvent back to summary

fireChangeEvent	back to summary
public boolean fireChangeEvent() Fires a change event on the selection's actor, if any. Called internally when the selection changes, depending on `setProgrammaticChangeEvents(boolean)`. Returns:boolean true if the change should be undone.

public boolean fireChangeEvent()

Fires a change event on the selection's actor, if any. Called internally when the selection changes, depending on setProgrammaticChangeEvents(boolean).

Returns:boolean: true if the change should be undone.

first	back to summary
public T first() Returns the first selected item, or null. Annotations @Null

first

back to summary

public T first()

Returns the first selected item, or null.

Annotations

@Null

getLastSelected	back to summary
public T getLastSelected() Makes a best effort to return the last item selected, else returns an arbitrary item or null if the selection is empty. Annotations @Null

getLastSelected

back to summary

public T getLastSelected()

Makes a best effort to return the last item selected, else returns an arbitrary item or null if the selection is empty.

Annotations

@Null

getMultiple	back to summary
public boolean getMultiple()

getProgrammaticChangeEvents	back to summary
public boolean getProgrammaticChangeEvents()

getRequired	back to summary
public boolean getRequired()

getToggle	back to summary
public boolean getToggle()

hasItems	back to summary
public boolean hasItems() Deprecated Use `notEmpty()`. Annotations @Deprecated

isDisabled	back to summary
public boolean isDisabled() Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.isDisabled.

isEmpty	back to summary
public boolean isEmpty()

items	back to summary
public OrderedSet<T> items()

iterator back to summary

iterator	back to summary
public Iterator<T> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.

public Iterator<T> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

notEmpty	back to summary
public boolean notEmpty()

remove	back to summary
public void remove(T item)

removeAll	back to summary
public void removeAll(Array<T> items)

revert	back to summary
pack-priv void revert()

set	back to summary
public void set(T item) Sets the selection to only the specified item.

setActor	back to summary
public void setActor(Actor actor) Parameters actor:Actor An actor to fire `ChangeEvent` on when the selection changes, or null.

setAll	back to summary
public void setAll(Array<T> items)

setDisabled back to summary

setDisabled	back to summary
public void setDisabled(boolean isDisabled) Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.setDisabled. If true, prevents `choose(Object)` from changing the selection. Default is false.

public void setDisabled(boolean isDisabled)

Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.setDisabled.

If true, prevents choose(Object) from changing the selection. Default is false.

setMultiple	back to summary
public void setMultiple(boolean multiple) If true, allows `choose(Object)` to select multiple items. Default is false.

setProgrammaticChangeEvents	back to summary
public void setProgrammaticChangeEvents(boolean programmaticChangeEvents) If false, only `choose(Object)` will fire a change event. Default is true.

setRequired	back to summary
public void setRequired(boolean required) If true, prevents `choose(Object)` from selecting none. Default is false.

setToggle	back to summary
public void setToggle(boolean toggle) If true, prevents `choose(Object)` from clearing the selection. Default is false.

size	back to summary
public int size()

snapshot	back to summary
pack-priv void snapshot()

toArray	back to summary
public Array<T> toArray()

toArray	back to summary
public Array<T> toArray(Array<T> array)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

public Class Selection<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail