xyz.cofe.gui.swing.tabs

Class TabHeader

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

xyz.cofe.gui.swing.tabs.TabHeader

All Implemented Interfaces:

ImageObserver, MenuContainer, Closeable, Serializable, AutoCloseable, Accessible, TabPane.TabQuery

Direct Known Subclasses:

CloseableTabHeader

public class TabHeader
extends JPanel
implements Closeable, TabPane.TabQuery

Заголовок вкладки

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TabHeader.Adapter Адаптер события заголовка
static class	TabHeader.CloseEvent событие закрытия вкладки
static interface	TabHeader.Event События заголовка
static interface	TabHeader.Listener Подписчик на события заголовка

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
TabHeader(JTabbedPane tabbedPane, Component tabOwner, boolean useOwnerName) Конструктор заголовка.

Method Summary

Modifier and Type	Method and Description
Closeable	addTabHeaderListener(TabHeader.Listener listener) Добавляет подписчика на события
Closeable	addTabHeaderListener(TabHeader.Listener listener, boolean weakLink) Добавляет подписчика на события
void	close() Вызывается контейнером вкладок, когда компонент удаляется из контейнера.
protected JButton	createButton(Action action) Создает кнопку для отображения ее в заголовке
protected JButton	destroyButton(Action action) Удаляет кнопку с заголовка
protected void	fireEvent(TabHeader.Event event) Рассылка уведомления подписчикам
xyz.cofe.collection.list.EventList<Action>	getActions() Возвращает список действий рядом сназванием вкладки
String	getFontFamily() Указывает имя/семейство шрифта
float	getFontSize() Указывает размер шрифта
Color	getTabBackground() Указывает цвет фона
JTabbedPane	getTabbedPane() Указывает компонент вкладки
Icon	getTabDisabledIcon() Указывает иконку обозначающую заблокированную вкладку
int	getTabDisplayedMnemonicIndex()
Color	getTabForeground() Указывает цвет текста
Set	getTabHeaderListeners() Возвращает подписчиков
Icon	getTabIcon() Указывает иконку отображаемую перед именем вкладки
int	getTabMnemonic()
Component	getTabOwner() Указывет компонент содержимое вкладки
String	getTabTitle() Возвращает текст закладки
String	getTabToolTipText() Указывает текст подсказки всплывающей при наведении мыши
boolean	hasTabHeaderListener(TabHeader.Listener listener) Проверяет наличие подписчика на события
protected boolean	isClosed() Проверят что данный объект уже закрыт для использования (отсуствуют ссылка на внешние объекты)
boolean	isFontBold() Указывает жирность шрифта
boolean	isFontItalic() Указывает наклонность шрифта
boolean	isTabEnabled() Указывает "разрешено ли" пользователю нажимать на кнопки заголовка
boolean	isUseOwnerNameAsTitle() Использовать свойство name у объекта владельца вкладки
void	removeTabHeaderListener(TabHeader.Listener listener) Отписка от уведомлений
void	setFontBold(boolean bold) Указывает жирность шрифта
void	setFontFamily(String family) Указывает имя/семейство шрифта
void	setFontItalic(boolean italic) Указывает наклонность шрифта
void	setFontSize(float size) Указывает размер шрифта
void	setTabBackground(Color background) Возвращает цвет фона
void	setTabbedPane(JTabbedPane tabbedPane) Указывает компонент вкладки
void	setTabDisabledIcon(Icon disabledIcon) Возвращает иконку обозначающую заблокированную вкладку
void	setTabDisplayedMnemonicIndex(int mnemonicIndex)
void	setTabEnabled(boolean enabled) Указывает "разрешено ли" пользователю нажимать на кнопки заголовка
void	setTabForeground(Color foreground) Указывает цвет текста
void	setTabIcon(Icon icon) Указывает иконку отображаемую перед именем вкладки
void	setTabMnemonic(int mnemonic)
void	setTabOwner(Component component) Указывает компонент содержимое вкладки
void	setTabTitle(String title) Указывает текст закладки
void	setTabToolTipText(String toolTipText) Указывает текст подсказки всплывающей при наведении мыши
protected void	setTitleLabelFont()
void	setUseOwnerNameAsTitle(boolean useOwnerNameAsTitle) Использовать свойство name у объекта владельца вкладки

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

TabHeader

public TabHeader(JTabbedPane tabbedPane,
                 Component tabOwner,
                 boolean useOwnerName)

Конструктор заголовка. Компонент соответ. вкладке должен быть на момент вызова конструктора присоединен к контейнеру.

Parameters:

tabbedPane - Контейнер вкладок

tabOwner - Компонент соответ. вкладке

useOwnerName - Использовать имя (свойство name) компонент соответ. вкладке (tabOwner)

Method Detail

isUseOwnerNameAsTitle

public boolean isUseOwnerNameAsTitle()

Использовать свойство name у объекта владельца вкладки

Returns:

true - использовать свойство name

See Also:

setTabOwner(java.awt.Component)

setUseOwnerNameAsTitle

public void setUseOwnerNameAsTitle(boolean useOwnerNameAsTitle)

Использовать свойство name у объекта владельца вкладки

Parameters:

useOwnerNameAsTitle - использовать свойство name

See Also:

setTabOwner(java.awt.Component)

getFontSize

public float getFontSize()

Указывает размер шрифта

Returns:

размер шрифта

getFontFamily

public String getFontFamily()

Указывает имя/семейство шрифта

Returns:

имя/семейство шрифта

isFontItalic

public boolean isFontItalic()

Указывает наклонность шрифта

Returns:

шрифт наклонен

isFontBold

public boolean isFontBold()

Указывает жирность шрифта

Returns:

жирный шрифт

setFontSize

public void setFontSize(float size)

Указывает размер шрифта

Parameters:

size - размер шрифта

setFontFamily

public void setFontFamily(String family)

Указывает имя/семейство шрифта

Parameters:

family - имя/семейство шрифта

setFontItalic

public void setFontItalic(boolean italic)

Указывает наклонность шрифта

Parameters:

italic - наклонность шрифта

setFontBold

public void setFontBold(boolean bold)

Указывает жирность шрифта

Parameters:

bold - жирность шрифта

setTitleLabelFont

protected void setTitleLabelFont()

getActions

public xyz.cofe.collection.list.EventList<Action> getActions()

Возвращает список действий рядом сназванием вкладки

Returns:

список действий (кнопок)

createButton

protected JButton createButton(Action action)

Создает кнопку для отображения ее в заголовке

Parameters:

action - действие

Returns:

кнопка

destroyButton

protected JButton destroyButton(Action action)

Удаляет кнопку с заголовка

Parameters:

action - действие связанное с кнопкой

Returns:

Удаленная кнопка

hasTabHeaderListener

public boolean hasTabHeaderListener(TabHeader.Listener listener)

Проверяет наличие подписчика на события

Parameters:

listener - подписчик

Returns:

true подписчик установлен

getTabHeaderListeners

public Set getTabHeaderListeners()

Возвращает подписчиков

Returns:

подписчики

addTabHeaderListener

public Closeable addTabHeaderListener(TabHeader.Listener listener)

Добавляет подписчика на события

Parameters:

listener - подписчик

Returns:

отписка от уведомлений

addTabHeaderListener

public Closeable addTabHeaderListener(TabHeader.Listener listener,
                                      boolean weakLink)

Добавляет подписчика на события

Parameters:

listener - подписчик

weakLink - true - добавить подписчика как weak ссылка / false - добавить как обычную ссылку

Returns:

отписка от уведомлений

removeTabHeaderListener

public void removeTabHeaderListener(TabHeader.Listener listener)

Отписка от уведомлений

Parameters:

listener - подписчик

fireEvent

protected void fireEvent(TabHeader.Event event)

Рассылка уведомления подписчикам

Parameters:

event - уведомление

isClosed

protected boolean isClosed()

Проверят что данный объект уже закрыт для использования (отсуствуют ссылка на внешние объекты)

Returns:

true - данный объект уже закрыт

close

public void close()
           throws IOException

Вызывается контейнером вкладок, когда компонент удаляется из контейнера. Удаляет ссылки на компоненты

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - Ошибка IO

setTabOwner

public void setTabOwner(Component component)

Указывает компонент содержимое вкладки

Specified by:

setTabOwner in interface TabPane.TabQuery

Parameters:

component - компонент содержимое вкладки

getTabOwner

public Component getTabOwner()

Указывет компонент содержимое вкладки

Returns:

компонент содержимое вкладки

getTabbedPane

public JTabbedPane getTabbedPane()

Указывает компонент вкладки

Returns:

компонент вкладки

setTabbedPane

public void setTabbedPane(JTabbedPane tabbedPane)

Указывает компонент вкладки

Parameters:

tabbedPane - компонент вкладки

setTabDisabledIcon

public void setTabDisabledIcon(Icon disabledIcon)

Возвращает иконку обозначающую заблокированную вкладку

Specified by:

setTabDisabledIcon in interface TabPane.TabQuery

Parameters:

disabledIcon - иконка заблокированной вкладку

getTabDisabledIcon

public Icon getTabDisabledIcon()

Указывает иконку обозначающую заблокированную вкладку

Returns:

иконка заблокированной вкладку

setTabDisplayedMnemonicIndex

public void setTabDisplayedMnemonicIndex(int mnemonicIndex)

Specified by:

setTabDisplayedMnemonicIndex in interface TabPane.TabQuery

getTabDisplayedMnemonicIndex

public int getTabDisplayedMnemonicIndex()

setTabIcon

public void setTabIcon(Icon icon)

Указывает иконку отображаемую перед именем вкладки

Specified by:

setTabIcon in interface TabPane.TabQuery

Parameters:

icon - иконка вкладки

getTabIcon

public Icon getTabIcon()

Указывает иконку отображаемую перед именем вкладки

Returns:

иконка вкладки

setTabMnemonic

public void setTabMnemonic(int mnemonic)

Specified by:

setTabMnemonic in interface TabPane.TabQuery

getTabMnemonic

public int getTabMnemonic()

setTabTitle

public void setTabTitle(String title)

Указывает текст закладки

Specified by:

setTabTitle in interface TabPane.TabQuery

Parameters:

title - текст закладки

getTabTitle

public String getTabTitle()

Возвращает текст закладки

Returns:

текст закладки

setTabBackground

public void setTabBackground(Color background)

Возвращает цвет фона

Specified by:

setTabBackground in interface TabPane.TabQuery

Parameters:

background - цвет фона

getTabBackground

public Color getTabBackground()

Указывает цвет фона

Returns:

цвет фона

setTabEnabled

public void setTabEnabled(boolean enabled)

Указывает "разрешено ли" пользователю нажимать на кнопки заголовка

Specified by:

setTabEnabled in interface TabPane.TabQuery

Parameters:

enabled - true - пользователю разрешено нажимать на кнопки

isTabEnabled

public boolean isTabEnabled()

Указывает "разрешено ли" пользователю нажимать на кнопки заголовка

Returns:

true - пользователю разрешено нажимать на кнопки

setTabForeground

public void setTabForeground(Color foreground)

Указывает цвет текста

Specified by:

setTabForeground in interface TabPane.TabQuery

Parameters:

foreground - цвет текста

getTabForeground

public Color getTabForeground()

Указывает цвет текста

Returns:

цвет текста

setTabToolTipText

public void setTabToolTipText(String toolTipText)

Указывает текст подсказки всплывающей при наведении мыши

Specified by:

setTabToolTipText in interface TabPane.TabQuery

Parameters:

toolTipText - текст подсказки

getTabToolTipText

public String getTabToolTipText()

Указывает текст подсказки всплывающей при наведении мыши

Returns:

текст подсказки