hu.scelightapi.gui.comp

Interface ITabbedPane

All Superinterfaces:

IBorderPanel

public interface ITabbedPane
extends IBorderPanel

An extended JTabbedPane.

Supports lazily created tab components which is very useful because only non-lazy tabs are created on first show which might be significantly faster, also if a user never clicks on a tab, it is never created.

Supports hiding tabs in a way that hidden tabs (both tab title and content components) remain in the component tree (which means bounded ISettingChangeListeners will properly be removed if ISettingsGui.removeAllBoundedScl(JComponent) is called on a parent.

Author:

Andras Belicza

See Also:

IGuiFactory.newTabbedPane()

Method Summary

Methods

Modifier and Type	Method and Description
void	addTab(java.lang.String title, IRIcon ricon, javax.swing.JComponent tab, boolean addTabMnemonic) Adds a new non-closeable tab.
void	addTab(java.lang.String title, IRIcon ricon, javax.swing.JComponent tab, boolean addTabMnemonic, boolean closeable, java.lang.Runnable beforeCloseTask) Adds a new tab.
void	addTab(java.lang.String title, IRIcon ricon, Producer<javax.swing.JComponent> tabProducer, boolean addTabMnemonic) Adds a new, lazily created non-closeable tab.
void	addTab(java.lang.String title, IRIcon ricon, Producer<javax.swing.JComponent> tabProducer, boolean addTabMnemonic, boolean closeable, java.lang.Runnable beforeCloseTask) Adds a new, lazily created tab.
IBorderPanel	asBorderPanel() Casts this instance to IBorderPanel.
int	getHiddenTabCount() Returns the hidden tab count.
int	getTabCount() Returns the visible tab count.
javax.swing.JTabbedPane	getWrappedTabbedPane() Returns the wrapped JTabbedPane.
void	hideTab(int idx) Hides the tab at the specified index.
void	unhideTab(int hiddenIdx, int toIdx) Unhides a tab specified by its hidden index, and inserts it to the specified index.

Methods inherited from interface hu.scelightapibase.gui.comp.IBorderPanel

addCenter, addEast, addNorth, addSouth, addWest, asPanel

Method Detail

asBorderPanel

IBorderPanel asBorderPanel()

Casts this instance to IBorderPanel.

Returns:

this as a IBorderPanel

getWrappedTabbedPane

javax.swing.JTabbedPane getWrappedTabbedPane()

Returns the wrapped JTabbedPane.

Returns:

the wrapped JTabbedPane

addTab

void addTab(java.lang.String title,
          IRIcon ricon,
          Producer<javax.swing.JComponent> tabProducer,
          boolean addTabMnemonic)

Adds a new, lazily created non-closeable tab.

Parameters:

title - title of the tab

ricon - ricon of the tab

tabProducer - tab component producer

addTabMnemonic - tells if a tab mnemonic has to be added

addTab

void addTab(java.lang.String title,
          IRIcon ricon,
          Producer<javax.swing.JComponent> tabProducer,
          boolean addTabMnemonic,
          boolean closeable,
          java.lang.Runnable beforeCloseTask)

Adds a new, lazily created tab.

Parameters:

title - title of the tab

ricon - ricon of the tab

tabProducer - tab component producer

addTabMnemonic - tells if a tab mnemonic has to be added

closeable - tells if the tab is closeable (adds a close icon if it is)

beforeCloseTask - optional task to be executed before close in case of closeable tabs

addTab

void addTab(java.lang.String title,
          IRIcon ricon,
          javax.swing.JComponent tab,
          boolean addTabMnemonic)

Adds a new non-closeable tab.

Parameters:

title - title of the tab

ricon - ricon of the tab

tab - tab component to be added

addTabMnemonic - tells if a tab mnemonic has to be added

addTab

void addTab(java.lang.String title,
          IRIcon ricon,
          javax.swing.JComponent tab,
          boolean addTabMnemonic,
          boolean closeable,
          java.lang.Runnable beforeCloseTask)

Adds a new tab.

Parameters:

title - title of the tab

ricon - ricon of the tab

tab - tab component to be added

addTabMnemonic - tells if a tab mnemonic has to be added

closeable - tells if the tab is closeable (adds a close icon if it is)

beforeCloseTask - optional task to be executed before close in case of closeable tabs

hideTab

void hideTab(int idx)

Hides the tab at the specified index.

Parameters:

idx - index of the tab to be hidden

unhideTab

void unhideTab(int hiddenIdx,
             int toIdx)

Unhides a tab specified by its hidden index, and inserts it to the specified index.

Parameters:

hiddenIdx - index of the tab to be unhidden, amongst the hidden tabs

toIdx - index to show the tab at

getTabCount

int getTabCount()

Returns the visible tab count.

Returns:

the visible tab count

getHiddenTabCount

int getHiddenTabCount()

Returns the hidden tab count.

Returns:

the hidden tab count