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

Interface WStack<N,I,IC>

Type Parameters:

N - the native widget

I - the native stack item widget

IC - the native stack item content widget

All Superinterfaces:

WDragSourceWidget, WDragTargetWidget, WLayoutedWidget<org.eclipse.e4.ui.model.application.ui.basic.MPartStack>, WMinMaxableWidget, WWidget<org.eclipse.e4.ui.model.application.ui.basic.MPartStack>

public interface WStack<N,I,IC>
extends WLayoutedWidget<org.eclipse.e4.ui.model.application.ui.basic.MPartStack>, WMinMaxableWidget, WDragSourceWidget, WDragTargetWidget

Abstraction of a stack widget

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WStack.WStackItem<I,IC> Abstraction representing an item in the stack

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

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

WMinMaxableWidget.WMinMaxState

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

WDragSourceWidget.DragData

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_PAGINATION Tag to use a pagination control

Method Summary

Modifier and Type	Method and Description
void	addItem(@NonNull WStack.WStackItem<I,IC> item) Append a stack item
void	addItems(int index, @NonNull java.util.List<WStack.WStackItem<I,IC>> items) Insert stack items at the given index
void	addItems(@NonNull java.util.List<WStack.WStackItem<I,IC>> items) Append multiple stack items
int	getItemCount()
@NonNull java.util.List<WStack.WStackItem<I,IC>>	getItems()
@NonNull java.lang.Class<? extends WStack.WStackItem<I,IC>>	getStackItemClass()
int	indexOf(@NonNull WStack.WStackItem<I,IC> item) The index of the item
void	removeItems(@NonNull java.util.List<WStack.WStackItem<I,IC>> items) Remove items
void	selectItem(int idx) Select the item at a given index
void	setKeySelectedItemCallback(@NonNull WCallback<WStack.WStackItem<I,IC>,java.lang.Void> selectedItemCallback) Set the callback to be used when the item is selected by the keyboard
void	setMouseSelectedItemCallback(@NonNull WCallback<WStack.WStackItem<I,IC>,java.lang.Void> selectedItemCallback) Set the callback to be used when the item is selected 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

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

setMinMaxCallback, setMinMaxState

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

setDragStartCallback

Field Detail

TAG_PAGINATION

static final java.lang.String TAG_PAGINATION

Tag to use a pagination control

See Also:

Constant Field Values

Method Detail

getStackItemClass

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

Returns:

the class used to represent the stack items

addItem

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

Append a stack item

Parameters:

item - the item

addItems

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

Append multiple stack items

Parameters:

items - the items to append

addItems

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

Insert stack items at the given index

Parameters:

index - the index

items - the items to add

selectItem

void selectItem(int idx)

Select the item at a given index

Parameters:

idx - the index to select

indexOf

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

The index of the item

Parameters:

item - the item

Returns:

the index or -1 if not found

getItems

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

Returns:

all items

removeItems

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

Remove items

Parameters:

items - the items to remove

setMouseSelectedItemCallback

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

Set the callback to be used when the item is selected by the mouse

Parameters:

selectedItemCallback - the callback

setKeySelectedItemCallback

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

Set the callback to be used when the item is selected by the keyboard

Parameters:

selectedItemCallback - the callback

getItemCount

int getItemCount()

Returns:

the number of items