Package de.lessvoid.nifty.controls

Interface TabGroup

All Superinterfaces:

NiftyControl

All Known Implementing Classes:

TabGroupControl

public interface TabGroup
extends NiftyControl

A tab group is the parent element to a set of tabs. It allows selecting exactly one of those tabs for displaying.

Author:

ractoc, Martin Karing <nitram@illarion.org>

Method Summary

Modifier and Type	Method	Description
void	addTab(Tab tab)	Adds a single tab to the end of the tab list.
void	addTab(TabBuilder tabBuilder)	Add a tab builder to the list.
void	addTab(Element tab)	Adds a single tab to the end of the tab list.
Tab	getSelectedTab()	Get the tab that is currently selected.
int	getSelectedTabIndex()	Get the index of the tab that is currently selected.
Tab	getTabAtIndex(int index)	Get the tab control at a specified index.
int	getTabCount()	Get the amount of tabs that are currently part of this tab group.
int	indexOf(Tab tab)	Get the index of a specified tab.
boolean	isTabInGroup(Tab tab)	Check if a tab is part of this group.
void	removeTab(int index)	Removes the tab at a specified list index.
void	removeTab(int index, EndNotify notify)	Removes the tab at a specified list index.
void	removeTab(Tab tab)	Remove a tab from this tab group.
void	removeTab(Tab tab, EndNotify notify)	Remove a tab from this tab group.
void	removeTab(Element tab)	Remove a tab from this tab group.
void	removeTab(Element tab, EndNotify notify)	Remove a tab from this tab group.
void	setSelectedTab(Tab tab)	Change the selected tab to a specified tab.
void	setSelectedTabIndex(int index)	Change the selected tab to a index.
void	setTabCaption(int index, java.lang.String caption)	Set the caption of a tab.
void	setTabCaption(Tab tab, java.lang.String caption)	Set the caption of a tab.

Methods inherited from interface de.lessvoid.nifty.controls.NiftyControl

disable, enable, getElement, getHeight, getId, getStyle, getWidth, hasFocus, isBound, isEnabled, layoutCallback, setEnabled, setFocus, setFocusable, setHeight, setId, setStyle, setWidth

Method Detail

addTab

void addTab(@Nonnull
            Tab tab)

Adds a single tab to the end of the tab list. Its best if the element this tab belongs to is already a child of the tab group. But if this is not the case, the tab will be moved to the proper spot.

Parameters:

tab - the tab that is supposed to be added to the tab group

addTab

void addTab(@Nonnull
            Element tab)

Adds a single tab to the end of the tab list. Its best if the element this tab belongs to is already a child of the tab group. But if this is not the case, the tab will be moved to the proper spot.

Parameters:

tab - the tab that is supposed to be added to the tab group

Throws:

java.lang.IllegalArgumentException - in case the tab does not contain a Tab as registered control

addTab

void addTab(@Nonnull
            TabBuilder tabBuilder)

Add a tab builder to the list.

This is the best way to add new tabs as this method ensures that the newly created tab is located correctly as child of this tab group and then added. This function automatically triggers the execution of the ElementBuilder.build(de.lessvoid.nifty.Nifty, de.lessvoid.nifty.screen.Screen, Element) function.

Parameters:

tabBuilder - the builder that is going to construct the tab that will be added to this tab group

getSelectedTab

@Nullable
Tab getSelectedTab()

Get the tab that is currently selected.

Returns:

the tab that is currently active or null in case there are no tabs in this tab group

getSelectedTabIndex

int getSelectedTabIndex()

Get the index of the tab that is currently selected.

Returns:

the index of the tab that is currently selected or -1 in case there are no tabs in this group

getTabCount

int getTabCount()

Get the amount of tabs that are currently part of this tab group.

Returns:

the amount of tabs that are part of this tab group

indexOf

int indexOf(@Nonnull
            Tab tab)

Get the index of a specified tab.

Parameters:

tab - the tab to check

Returns:

the index of this tab or -1 in case the tab is not part of this group or null

isTabInGroup

boolean isTabInGroup(@Nonnull
                     Tab tab)

Check if a tab is part of this group.

Parameters:

tab - the tab to check

Returns:

true in case the tab is registered to this group

removeTab

void removeTab(int index)

Removes the tab at a specified list index.

Parameters:

index - the index of the tab that is supposed to be removed

Throws:

java.lang.IndexOutOfBoundsException - in case the index parameter is less then 0 or larger then getTabCount()

removeTab

void removeTab(@Nonnull
               Tab tab)

Remove a tab from this tab group.

Parameters:

tab - the tab that is supposed to be removed

Throws:

java.lang.IllegalArgumentException - in case the tab that is supposed to be removed is not a part of this tab group

removeTab

void removeTab(@Nonnull
               Element tab)

Remove a tab from this tab group.

Parameters:

tab - the tab that is supposed to be removed

Throws:

java.lang.IllegalArgumentException - in case the tab that is supposed to be removed is not a part of this tab group or in case the tab does not contain a Tab as registered control

removeTab

void removeTab(int index,
               @Nullable
               EndNotify notify)

Removes the tab at a specified list index.

Parameters:

index - the index of the tab that is supposed to be removed

notify - the notification that is called once the tab is removed

Throws:

java.lang.IndexOutOfBoundsException - in case the index parameter is less then 0 or larger then getTabCount()

removeTab

void removeTab(@Nonnull
               Tab tab,
               @Nullable
               EndNotify notify)

Remove a tab from this tab group.

Parameters:

tab - the tab that is supposed to be removed

notify - the notification that is called once the tab is removed

Throws:

java.lang.IllegalArgumentException - in case the tab that is supposed to be removed is not a part of this tab group

removeTab

void removeTab(@Nonnull
               Element tab,
               @Nullable
               EndNotify notify)

Remove a tab from this tab group.

Parameters:

tab - the tab that is supposed to be removed

notify - the notification that is called once the tab is removed

Throws:

java.lang.IllegalArgumentException - in case the tab that is supposed to be removed is not a part of this tab group or in case the tab does not contain a Tab as registered control

setSelectedTab

void setSelectedTab(@Nonnull
                    Tab tab)

Change the selected tab to a specified tab.

Parameters:

tab - the tab that is supposed to be displayed in the tab group

Throws:

java.lang.IllegalArgumentException - in case the tab that is supposed to be removed is not a part of this tab group

setSelectedTabIndex

void setSelectedTabIndex(int index)

Change the selected tab to a index.

Parameters:

index - the index of the tab that is supposed to be displayed

Throws:

java.lang.IndexOutOfBoundsException - in case the index parameter is less then 0 or larger then getTabCount()

setTabCaption

void setTabCaption(int index,
                   @Nonnull
                   java.lang.String caption)

Set the caption of a tab.

Parameters:

index - the index of the tab that is supposed to get a new caption

caption - the new caption of this tab

Throws:

java.lang.IndexOutOfBoundsException - in case the index parameter is less then 0 or larger then getTabCount()

setTabCaption

void setTabCaption(@Nonnull
                   Tab tab,
                   @Nonnull
                   java.lang.String caption)

Set the caption of a tab.

Parameters:

tab - the tab that is supposed to receive a new caption

caption - the new caption of this tab

Throws:

java.lang.IllegalArgumentException - in case the tab that is supposed to be removed is not a part of this tab group

getTabAtIndex

@Nullable
Tab getTabAtIndex(int index)

Get the tab control at a specified index.

Parameters:

index - the index of the tab control

Returns:

the tab control