bibliothek.gui.dock.displayer

Interface SingleTabDecider

public interface SingleTabDecider

Decides for Dockables whether there should be a single tab shown for them.

Author:

Benjamin Sigg

Field Summary

Fields

Modifier and Type	Field and Description
static SingleTabDecider	ALLWAYS Deprecated. please use ALWAYS instead
static SingleTabDecider	ALWAYS this decider shows a tab, unless the element is a station itself or on a StackDockStation
static SingleTabDecider	NONE this decider never shows a tab
static PropertyKey<SingleTabDecider>	SINGLE_TAB_DECIDER Key for the DockProperties

Method Summary

Modifier and Type	Method and Description
void	addSingleTabDeciderListener(SingleTabDeciderListener listener) Adds a listener to this decider, the listener is to be informed if the single tab property of a Dockable changes.
void	removeSingleTabDeciderListener(SingleTabDeciderListener listener) Removes a listener from this decider.
boolean	showSingleTab(DockStation station, Dockable dockable) Decides whether to show a single tab for dockable

Field Detail

NONE

static final SingleTabDecider NONE

this decider never shows a tab

ALWAYS

static final SingleTabDecider ALWAYS

this decider shows a tab, unless the element is a station itself or on a StackDockStation

ALLWAYS

@Deprecated
 @Todo(target=VERSION_1_1_3,
      priority=MINOR,
      compatibility=BREAK_MINOR,
      description="remove this constant without replacement")
static final SingleTabDecider ALLWAYS

Deprecated. please use ALWAYS instead

This decider shows a tab, unless the element is a station itself or on a StackDockStation

SINGLE_TAB_DECIDER

static final PropertyKey<SingleTabDecider> SINGLE_TAB_DECIDER

Key for the DockProperties

Method Detail

showSingleTab

boolean showSingleTab(DockStation station,
                      Dockable dockable)

Decides whether to show a single tab for dockable

Parameters:

station - the parent of dockable

dockable - the element for which a single tab might be shown

Returns:

true if a tab should be shown, false if not

addSingleTabDeciderListener

void addSingleTabDeciderListener(SingleTabDeciderListener listener)

Adds a listener to this decider, the listener is to be informed if the single tab property of a Dockable changes.

Parameters:

listener - the new listener

removeSingleTabDeciderListener

void removeSingleTabDeciderListener(SingleTabDeciderListener listener)

Removes a listener from this decider.

Parameters:

listener - the listener to remove