org.eclipse.fx.ui.workbench.renderers.base.widget

Interface WPerspectiveStack<N,I,IC>

Type Parameters:

N - the native widget

I - the stack item type

IC - the type of the stack items content

All Superinterfaces:

WDragTargetWidget, WLayoutedWidget<org.eclipse.e4.ui.model.application.ui.advanced.MPerspectiveStack>, WWidget<org.eclipse.e4.ui.model.application.ui.advanced.MPerspectiveStack>

public interface WPerspectiveStack<N,I,IC>
extends WLayoutedWidget<org.eclipse.e4.ui.model.application.ui.advanced.MPerspectiveStack>

Abstraction of the perspective stack

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WPerspectiveStack.WStackItem<I,IC> Abstraction of the stack item

Nested classes/interfaces inherited from interface org.eclipse.fx.ui.workbench.renderers.base.widget.WWidget

WWidget.WidgetState

Nested classes/interfaces inherited from interface org.eclipse.fx.ui.workbench.renderers.base.widget.WDragTargetWidget

WDragTargetWidget.DropData, WDragTargetWidget.DropType

Method Summary

Modifier and Type	Method and Description
void	addItem(@NonNull WPerspectiveStack.WStackItem<I,IC> item) Append an item to the stack
void	addItems(int index, @NonNull java.util.List<WPerspectiveStack.WStackItem<I,IC>> items) Insert items at the given index
void	addItems(@NonNull java.util.List<WPerspectiveStack.WStackItem<I,IC>> items) Append a list if items to the stack
int	getItemCount()
@NonNull java.util.List<WPerspectiveStack.WStackItem<I,IC>>	getItems()
@NonNull java.lang.Class<? extends WPerspectiveStack.WStackItem<I,IC>>	getStackItemClass()
int	indexOf(@NonNull WPerspectiveStack.WStackItem<I,IC> item) Find the index of the given item
void	removeItems(@NonNull java.util.List<WPerspectiveStack.WStackItem<I,IC>> items) Remove items
void	selectItem(int idx) Select the item at the index
void	setKeySelectedItemCallback(@NonNull WCallback<WPerspectiveStack.WStackItem<I,IC>,java.lang.Void> selectedItemCallback) Callback invoked when the activation is done by the keyboard
void	setMouseSelectedItemCallback(@NonNull WCallback<WPerspectiveStack.WStackItem<I,IC>,java.lang.Void> selectedItemCallback) Callback invoked when activation is done by the mouse

Methods inherited from interface org.eclipse.fx.ui.workbench.renderers.base.widget.WLayoutedWidget

getStaticLayoutNode, getWeight

Methods inherited from interface org.eclipse.fx.ui.workbench.renderers.base.widget.WWidget

activate, addStyleClasses, addStyleClasses, deactivate, getDomElement, getWidget, getWidgetState, isActive, registerActivationCallback, removeStyleClasses, removeStyleClasses, setDomElement, setPropertyChangeHandler, setStyleId, setWidgetState

Methods inherited from interface org.eclipse.fx.ui.workbench.renderers.base.widget.WDragTargetWidget

getDropDroppedCallback, setDragDroppedCallback

Method Detail

getStackItemClass

@NonNull java.lang.Class<? extends WPerspectiveStack.WStackItem<I,IC>> getStackItemClass()

Returns:

the class type representing the stack item

addItem

void addItem(@NonNull WPerspectiveStack.WStackItem<I,IC> item)

Append an item to the stack

Parameters:

item - the item

addItems

void addItems(@NonNull java.util.List<WPerspectiveStack.WStackItem<I,IC>> items)

Append a list if items to the stack

Parameters:

items - the list of items

addItems

void addItems(int index,
              @NonNull java.util.List<WPerspectiveStack.WStackItem<I,IC>> items)

Insert items at the given index

Parameters:

index - the index

items - the items

selectItem

void selectItem(int idx)

Select the item at the index

Parameters:

idx - the index

indexOf

int indexOf(@NonNull WPerspectiveStack.WStackItem<I,IC> item)

Find the index of the given item

Parameters:

item - the item

Returns:

the index or -1 if not found

getItems

@NonNull java.util.List<WPerspectiveStack.WStackItem<I,IC>> getItems()

Returns:

all stack items

removeItems

void removeItems(@NonNull java.util.List<WPerspectiveStack.WStackItem<I,IC>> items)

Remove items

Parameters:

items - the items

setMouseSelectedItemCallback

void setMouseSelectedItemCallback(@NonNull WCallback<WPerspectiveStack.WStackItem<I,IC>,java.lang.Void> selectedItemCallback)

Callback invoked when activation is done by the mouse

Parameters:

selectedItemCallback - the callback to invoke

setKeySelectedItemCallback

void setKeySelectedItemCallback(@NonNull WCallback<WPerspectiveStack.WStackItem<I,IC>,java.lang.Void> selectedItemCallback)

Callback invoked when the activation is done by the keyboard

Parameters:

selectedItemCallback - the callback to invoke

getItemCount

int getItemCount()

Returns:

number of items