Module io.github.tonywasher.joceanus.tethys.core

Package io.github.tonywasher.joceanus.tethys.api.control

Interface TethysUITreeManager<T>

Type Parameters:

T - the item type

All Superinterfaces:

OceanusEventRegistrar.OceanusEventProvider<TethysUIEvent>, TethysUIComponent

All Known Implementing Classes:

TethysUICoreTreeManager

public interface TethysUITreeManager<T>
extends OceanusEventRegistrar.OceanusEventProvider<TethysUIEvent>, TethysUIComponent

Tree Manager.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TethysUITreeManager.TethysUITreeItem<T>	TreeItem class.

Method Summary

Modifier and Type	Method	Description
TethysUITreeManager.TethysUITreeItem<T>	addChildItem(TethysUITreeManager.TethysUITreeItem<T> pParent, String pName, T pItem)	Add item to parent.
TethysUITreeManager.TethysUITreeItem<T>	addRootItem(String pName, T pItem)	Add item to root.
TethysUIIcon	getIcon(TethysUIIconId pIconId)	Obtain the icon for the iconId.
TethysUITreeManager.TethysUITreeItem<T>	getRoot()	Obtain the root.
T	getSelectedItem()	Obtain the selected item.
boolean	isVisible()	Is the tree visible?
boolean	lookUpAndSelectItem(String pName)	Select and display item.
TethysUITreeManager.TethysUITreeItem<T>	lookUpItem(String pName)	LookUp item by name.
void	setRootName(String pName)	Set the root name.
void	setRootVisible()	Set the root as visible.

Methods inherited from interface io.github.tonywasher.joceanus.oceanus.event.OceanusEventRegistrar.OceanusEventProvider

getEventRegistrar

Methods inherited from interface io.github.tonywasher.joceanus.tethys.api.base.TethysUIComponent

getBorderPadding, getBorderTitle, getId, getNode, getUnderlying, setBorderPadding, setBorderTitle, setEnabled, setPreferredHeight, setPreferredWidth, setVisible

Method Details

getSelectedItem

T getSelectedItem()

Obtain the selected item.

Returns:

the item.

setRootVisible

void setRootVisible()

Set the root as visible.

getRoot

TethysUITreeManager.TethysUITreeItem<T> getRoot()

Obtain the root.

Returns:

the root

setRootName

void setRootName(String pName)

Set the root name.

Parameters:

pName - the root name

isVisible

boolean isVisible()

Is the tree visible?

Returns:

true/false

lookUpAndSelectItem

boolean lookUpAndSelectItem(String pName)

Select and display item.

Parameters:

pName - the name of the item

Returns:

was an item selected? true/false

lookUpItem

TethysUITreeManager.TethysUITreeItem<T> lookUpItem(String pName)

LookUp item by name.

Parameters:

pName - the name of the item

Returns:

the item (or null)

addRootItem

TethysUITreeManager.TethysUITreeItem<T> addRootItem(String pName,
 T pItem)

Add item to root.

Parameters:

pName - the name

pItem - the item

Returns:

the new tree item

addChildItem

TethysUITreeManager.TethysUITreeItem<T> addChildItem(TethysUITreeManager.TethysUITreeItem<T> pParent,
 String pName,
 T pItem)

Add item to parent.

Parameters:

pParent - the parent

pName - the name

pItem - the item

Returns:

the new tree item

getIcon

TethysUIIcon getIcon(TethysUIIconId pIconId)

Obtain the icon for the iconId.

Parameters:

pIconId - the iconId

Returns:

the icon