org.hkijena.jipipe.ui.components.tabs

Class DocumentTabPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.hkijena.jipipe.ui.components.tabs.DocumentTabPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class DocumentTabPane
extends JPanel

JTabbedPane with larger tabs, ability to close tabs, singleton tabs that are hidden instead of being closed

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentTabPane.CloseMode Behavior of the tab close button
static class	DocumentTabPane.DocumentTab Encapsulates a tab
static class	DocumentTabPane.DocumentTabComponent
static class	DocumentTabPane.SingletonTab Encapsulates a singleton tab
static class	DocumentTabPane.SingletonTabMode
static class	DocumentTabPane.TabRenamedEvent

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
DocumentTabPane()
DocumentTabPane(boolean scrollable) Creates a new instance

Method Summary

Modifier and Type	Method and Description
DocumentTabPane.DocumentTab	addTab(String title, Icon icon, Component component, DocumentTabPane.CloseMode closeMode) Adds a new tab
DocumentTabPane.DocumentTab	addTab(String title, Icon icon, Component component, DocumentTabPane.CloseMode closeMode, boolean allowRename) Adds a new tab
void	closeAllTabs(boolean force) Closes all tabs
void	closeAllTabsExcept(DocumentTabPane.DocumentTab exception, boolean force) Closes all tabs except the provided one.
void	closeTab(DocumentTabPane.DocumentTab tab) Closes the tab.
void	closeTab(DocumentTabPane.DocumentTab tab, boolean force) Closes a tab.
JFrame	detachTab(JComponent parent, DocumentTabPane.DocumentTab tab, boolean reattachAfterClose) Detaches a tab
String	findTabNameFor(Component component) Finds the tab title for the content
void	forceCloseTab(DocumentTabPane.DocumentTab tab) Closes the tab.
Component	getCurrentContent()
String	getCurrentlySelectedSingletonTabId() Returns the currently selected singleton tab ID.
BiMap<String,DocumentTabPane.DocumentTab>	getSingletonTabInstances()
BiMap<String,DocumentTabPane.SingletonTab>	getSingletonTabs()
JTabbedPane	getTabbedPane()
DocumentTabPane.DocumentTab	getTabContainingContent(Component content) Returns the tab that contains the specified content
DocumentTabPane.DocumentTab	getTabContainingTabComponent(Component content) Returns the tab that contains the specified tab component
int	getTabCount()
Border	getTabPanelBorder()
Set<DocumentTabPane.DocumentTab>	getTabs()
List<DocumentTabPane.DocumentTab>	getTabsContaining(Class<? extends Component> klass) Returns all tabs that contain components of provided type or components that inherit from it
boolean	isEnableTabContextMenu()
boolean	isScrollable()
DocumentTabPane.SingletonTab	registerSingletonTab(String id, String title, Icon icon, Supplier<Component> componentSupplier, DocumentTabPane.CloseMode closeMode, DocumentTabPane.SingletonTabMode singletonTabMode) Adds a tab that can be silently closed and brought up again
DocumentTabPane.SingletonTab	registerSingletonTab(String id, String title, Icon icon, Supplier<Component> componentSupplier, DocumentTabPane.SingletonTabMode singletonTabMode) Adds a tab that can be silently closed and brought up again
DocumentTabPane.DocumentTab	selectSingletonTab(String id) Re-opens or selects a singleton tab
void	setEnableTabContextMenu(boolean enableTabContextMenu)
void	setScrollable(boolean scrollable)
void	setTabPanelBorder(Border tabPanelBorder)
void	switchToContent(Component content) Switches to the provided content
void	switchToLastTab() Switches the the last tab.
void	switchToTab(DocumentTabPane.DocumentTab tab) Switches to the provided tab

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentTabPane

public DocumentTabPane()

DocumentTabPane

public DocumentTabPane(boolean scrollable)

Creates a new instance

Method Detail

isScrollable

public boolean isScrollable()

setScrollable

public void setScrollable(boolean scrollable)

getSingletonTabs

public BiMap<String,DocumentTabPane.SingletonTab> getSingletonTabs()

getSingletonTabInstances

public BiMap<String,DocumentTabPane.DocumentTab> getSingletonTabInstances()

getTabContainingContent

public DocumentTabPane.DocumentTab getTabContainingContent(Component content)

Returns the tab that contains the specified content

Parameters:

content - the content

Returns:

the tab containing the content. Null if not found

getTabContainingTabComponent

public DocumentTabPane.DocumentTab getTabContainingTabComponent(Component content)

Returns the tab that contains the specified tab component

Parameters:

content - the content

Returns:

the tab containing the content. Null if not found

getTabs

public Set<DocumentTabPane.DocumentTab> getTabs()

getTabsContaining

public List<DocumentTabPane.DocumentTab> getTabsContaining(Class<? extends Component> klass)

Returns all tabs that contain components of provided type or components that inherit from it

Parameters:

klass - component type.

Returns:

tabs that contain components of provided type or components that inherit from it

getTabPanelBorder

public Border getTabPanelBorder()

setTabPanelBorder

public void setTabPanelBorder(Border tabPanelBorder)

addTab

public DocumentTabPane.DocumentTab addTab(String title,
                                          Icon icon,
                                          Component component,
                                          DocumentTabPane.CloseMode closeMode,
                                          boolean allowRename)

Adds a new tab

Parameters:

title - The tab title

icon - The tab icon

component - The tab content

closeMode - Behavior of the close button

allowRename - if true, users can rename the tab

Returns:

The tab

closeAllTabsExcept

public void closeAllTabsExcept(DocumentTabPane.DocumentTab exception,
                               boolean force)

Closes all tabs except the provided one.

Parameters:

exception - the tab that should be excluded

force - if non-closable tabs are affected

detachTab

public JFrame detachTab(JComponent parent,
                        DocumentTabPane.DocumentTab tab,
                        boolean reattachAfterClose)

Detaches a tab

Parameters:

tab - the tab

reattachAfterClose - if the window is closed, re-attach the tab (always true for non-closable tabs)

closeTab

public void closeTab(DocumentTabPane.DocumentTab tab,
                     boolean force)

Closes a tab.

Parameters:

tab - the tab.

force - if non-closable tabs are affected

closeTab

public void closeTab(DocumentTabPane.DocumentTab tab)

Closes the tab. This includes user interaction. Silently fails if the tab is not closable

Parameters:

tab - the tab

forceCloseTab

public void forceCloseTab(DocumentTabPane.DocumentTab tab)

Closes the tab. Has no user interaction.

Parameters:

tab - the tab

addTab

public DocumentTabPane.DocumentTab addTab(String title,
                                          Icon icon,
                                          Component component,
                                          DocumentTabPane.CloseMode closeMode)

Adds a new tab

Parameters:

title - the tab icon

icon - the tab icon

component - the tab content

closeMode - Behavior of the close button

Returns:

The tab

getTabbedPane

public JTabbedPane getTabbedPane()

getTabCount

public int getTabCount()

Returns:

the number of managed tabs

switchToLastTab

public void switchToLastTab()

Switches the the last tab. Fails silently if there are no tabs

registerSingletonTab

public DocumentTabPane.SingletonTab registerSingletonTab(String id,
                                                         String title,
                                                         Icon icon,
                                                         Supplier<Component> componentSupplier,
                                                         DocumentTabPane.SingletonTabMode singletonTabMode)

Adds a tab that can be silently closed and brought up again

Parameters:

id - Unique tab identifier

title - Tab title

icon - Tab icon

componentSupplier - Tab content

singletonTabMode - If the tab is hidden by default

getCurrentlySelectedSingletonTabId

public String getCurrentlySelectedSingletonTabId()

Returns the currently selected singleton tab ID. Null otherwise.

Returns:

the singleton tab ID. Null otherwise.

registerSingletonTab

public DocumentTabPane.SingletonTab registerSingletonTab(String id,
                                                         String title,
                                                         Icon icon,
                                                         Supplier<Component> componentSupplier,
                                                         DocumentTabPane.CloseMode closeMode,
                                                         DocumentTabPane.SingletonTabMode singletonTabMode)

Adds a tab that can be silently closed and brought up again

Parameters:

id - Unique tab identifier

title - Tab title

icon - Tab icon

componentSupplier - Tab content

singletonTabMode - How the singleton tab is displayed

selectSingletonTab

public DocumentTabPane.DocumentTab selectSingletonTab(String id)

Re-opens or selects a singleton tab

Parameters:

id - the singleton tab ID

Returns:

the tab. null if there is no such singleton tab

findTabNameFor

public String findTabNameFor(Component component)

Finds the tab title for the content

Parameters:

component - the tab content

Returns:

the tab title. Returns "Document" if the tab could not be found

switchToTab

public void switchToTab(DocumentTabPane.DocumentTab tab)

Switches to the provided tab

Parameters:

tab - the tab

switchToContent

public void switchToContent(Component content)

Switches to the provided content

Parameters:

content - the tab content

getCurrentContent

public Component getCurrentContent()

Returns:

the currently selected content

closeAllTabs

public void closeAllTabs(boolean force)

Closes all tabs

Parameters:

force - if non-closable tabs will be closed

isEnableTabContextMenu

public boolean isEnableTabContextMenu()

setEnableTabContextMenu

public void setEnableTabContextMenu(boolean enableTabContextMenu)