Package de.lessvoid.nifty.controls

Interface Tab

All Superinterfaces:

NiftyControl

All Known Implementing Classes:

TabControl

public interface Tab
extends NiftyControl

This interface allows to take control over a single tab. This tab is supposed to be the part of a TabGroup. For the most aspects it behaves like a simple panel.

Author:

ractoc, Martin Karing <nitram@illarion.org>

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCaption()	Get the caption that is currently set for this tab.
TabGroup	getParentGroup()	Get the parent group of tabs this tab is a member of.
boolean	hasParent()	Check if this tab was added to a parent tab group.
boolean	isVisible()	Check if this tab is the one that is currently visible in a tab group.
void	setCaption(java.lang.String caption)	Set the caption of the 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

getCaption

@Nonnull
java.lang.String getCaption()

Get the caption that is currently set for this tab.

Returns:

the current caption of this tab

getParentGroup

@Nullable
TabGroup getParentGroup()

Get the parent group of tabs this tab is a member of.

Returns:

the tab group this tab belongs to or null in case this tab is not yet assigned to a tab group

hasParent

boolean hasParent()

Check if this tab was added to a parent tab group.

Returns:

true if this tab is part of a group

isVisible

boolean isVisible()

Check if this tab is the one that is currently visible in a tab group.

Returns:

true if this tab is the one currently displayed

setCaption

void setCaption(@Nonnull
                java.lang.String caption)

Set the caption of the tab. This is the text that will be displayed in the button that turns this tab visible.

Parameters:

caption - the text to display