com.kotcrab.vis.ui.widget.tabbedpane

Class TabbedPane

java.lang.Object

com.kotcrab.vis.ui.widget.tabbedpane.TabbedPane

public class TabbedPane
extends Object

A tabbed pane, allows to have multiple tabs open and switch between them. TabbedPane does not handle displaying tab content, you have to do that manually using tabbed pane listener to get tab content table (see Tab.getContentTable() and TabbedPaneListener). All tabs must extend Tab class.

Since 0.9.3, tabbed pane uses an internal DragPane to make the tabs draggable. You can completely turn off this functionality by setting TabbedPane.TabbedPaneStyle.draggable to false. To turn off the drag listener at runtime, use getTabsPane() method to get a reference of DragPane, and invoke DragPane.setDraggable(Draggable) with null argument - this will clear draggable listener from all tabs' buttons; naturally, setting this value to non-null Draggable listener will also add it to all buttons.

Since:

0.7.0

Author:

Kotcrab, MJ

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TabbedPane.TabbedPaneStyle

Constructor Summary

Constructors

Constructor and Description
TabbedPane()
TabbedPane(String styleName)
TabbedPane(TabbedPane.TabbedPaneStyle style)

Method Summary

Modifier and Type	Method and Description
void	add(Tab tab)
void	addListener(TabbedPaneListener listener)
protected void	addTab(Tab tab, int index)
void	disableTab(Tab tab, boolean disable) Disables or enables given tab.
Tab	getActiveTab()
com.badlogic.gdx.scenes.scene2d.ui.Table	getTable()
com.badlogic.gdx.utils.Array<Tab>	getTabs()
DragPane	getTabsPane()
protected String	getTabTitle(Tab tab)
void	insert(int index, Tab tab)
boolean	isAllowTabDeselect()
boolean	isTabDisabled(Tab tab)
boolean	remove(Tab tab) Removes tab from pane, if tab is dirty this won't cause to display "Unsaved changes" dialog!
boolean	remove(Tab tab, boolean ignoreTabDirty) Removes tab from pane, if tab is dirty and 'ignoreTabDirty == false' this will cause to display "Unsaved changes" dialog!
void	removeAll() Removes all tabs, ignores if tab is dirty
boolean	removeListener(TabbedPaneListener listener)
void	setAllowTabDeselect(boolean allowTabDeselect)
void	switchTab(int index)
void	switchTab(Tab tab)
protected void	throwNotBelongingTabException(Tab tab)
void	updateTabTitle(Tab tab) Must be called when you want to update tab title.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TabbedPane

public TabbedPane()

TabbedPane

public TabbedPane(String styleName)

TabbedPane

public TabbedPane(TabbedPane.TabbedPaneStyle style)

Method Detail

getTabsPane

public DragPane getTabsPane()

Returns:

a direct reference to internal DragPane. Allows to manage Draggable settings.

setAllowTabDeselect

public void setAllowTabDeselect(boolean allowTabDeselect)

Parameters:

allowTabDeselect - if true user may deselect tab, meaning that there won't be any active tab. Allows to create similar behaviour like in Intellij IDEA bottom quick access bar

isAllowTabDeselect

public boolean isAllowTabDeselect()

add

public void add(Tab tab)

insert

public void insert(int index,
                   Tab tab)

addTab

protected void addTab(Tab tab,
                      int index)

Parameters:

tab - will be added in the selected index.

index - index of the tab, starting from zero.

disableTab

public void disableTab(Tab tab,
                       boolean disable)

Disables or enables given tab.

When disabling, if tab is currently selected, TabbedPane will switch to first available enabled Tab. If there is no any other enabled Tab, listener TabbedPaneListener.switchedTab(Tab) with null Tab will be called.

When enabling Tab and there isn't any others Tab enabled and setAllowTabDeselect(boolean) was set to false, passed Tab will be selected. If setAllowTabDeselect(boolean) is set to true nothing will be selected, all tabs will remain unselected.

Parameters:

tab - tab to change its state

disable - controls whether to disable or enable this tab

Throws:

IllegalArgumentException - if tab does not belong to this TabbedPane

isTabDisabled

public boolean isTabDisabled(Tab tab)

throwNotBelongingTabException

protected void throwNotBelongingTabException(Tab tab)

remove

public boolean remove(Tab tab)

Removes tab from pane, if tab is dirty this won't cause to display "Unsaved changes" dialog!

Parameters:

tab - to be removed

Returns:

true if tab was removed, false if that tab wasn't added to this pane

remove

public boolean remove(Tab tab,
                      boolean ignoreTabDirty)

Removes tab from pane, if tab is dirty and 'ignoreTabDirty == false' this will cause to display "Unsaved changes" dialog!

Returns:

true if tab was removed, false if that tab wasn't added to this pane or "Unsaved changes" dialog was started

removeAll

public void removeAll()

Removes all tabs, ignores if tab is dirty

switchTab

public void switchTab(int index)

switchTab

public void switchTab(Tab tab)

updateTabTitle

public void updateTabTitle(Tab tab)

Must be called when you want to update tab title. If tab is dirty an '*' is added before title. This is called automatically if using Tab.setDirty(boolean)

Parameters:

tab - that title will be updated

getTabTitle

protected String getTabTitle(Tab tab)

getTable

public com.badlogic.gdx.scenes.scene2d.ui.Table getTable()

getActiveTab

public Tab getActiveTab()

Returns:

active tab or null if no tab is selected.

addListener

public void addListener(TabbedPaneListener listener)

removeListener

public boolean removeListener(TabbedPaneListener listener)

getTabs

public com.badlogic.gdx.utils.Array<Tab> getTabs()