xdev.ui

Class XdevTabbedPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTabbedPane

xdev.ui.XdevTabbedPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants, Persistable

@BeanSettings(acceptChildren=true,
              useXdevCustomizer=true)
public class XdevTabbedPane
extends JTabbedPane
implements Persistable

The standard tabbed pane in XDEV. Based on JTabbedPane.

Since:

2.0

Author:

XDEV Software

See Also:

JTabbedPane, Serialized Form

Nested Class Summary

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

JTabbedPane.AccessibleJTabbedPane, JTabbedPane.ModelListener

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.JTabbedPane

changeEvent, changeListener, model, SCROLL_TAB_LAYOUT, tabPlacement, WRAP_TAB_LAYOUT

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 xdev.ui.persistence.Persistable

VALUE_SEPARATOR

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
XdevTabbedPane() Creates an empty TabbedPane with a default tab placement of JTabbedPane.TOP.
XdevTabbedPane(int tabPlacement) Creates an empty TabbedPane with the specified tab placement of either: JTabbedPane.TOP, JTabbedPane.BOTTOM, JTabbedPane.LEFT, or JTabbedPane.RIGHT.
XdevTabbedPane(int tabPlacement, int tabLayoutPolicy) Creates an empty TabbedPane with the specified tab placement and tab layout policy.

Method Summary

Modifier and Type	Method and Description
Component	add(Component comp) Use addTab(XdevTab) to add a XdevTab to the XdevTabbedPane.
Component	add(Component comp, int index) Use addTab(XdevTab) to add a XdevTab to the XdevTabbedPane.
void	add(Component comp, Object constraints) Use addTab(XdevTab) to add a XdevTab to the XdevTabbedPane.
void	add(Component comp, Object constraints, int index) Use addTab(XdevTab) to add a XdevTab to the XdevTabbedPane.
Component	add(String name, Component comp) Use addTab(XdevTab) to add a XdevTab to the XdevTabbedPane.
void	addTab(XdevTab tab) Adds a XdevTab to the this XdevTabbedPane.
String	getPersistentId() Uses the name of the component as a persistent id.
Component	getTabAt(int index) Returns the component at index.
void	insertTab(String title, Icon icon, Component component, String tip, int index)
boolean	isPersistenceEnabled() Flag, indicates, if the gui state for this component should be persisted.
void	loadPersistentState(String persistentState) Restores this Components persistent state.
String	savePersistentState() Generates a String representation of this Components persistent state and returns it for being stored.
void	setPersistenceEnabled(boolean persistenceEnabled) Sets the persistenceEnabled flag.
String	toString()

Methods inherited from class javax.swing.JTabbedPane

addChangeListener, addTab, addTab, addTab, createChangeListener, fireStateChanged, getAccessibleContext, getBackgroundAt, getBoundsAt, getChangeListeners, getComponentAt, getDisabledIconAt, getDisplayedMnemonicIndexAt, getForegroundAt, getIconAt, getMnemonicAt, getModel, getSelectedComponent, getSelectedIndex, getTabComponentAt, getTabCount, getTabLayoutPolicy, getTabPlacement, getTabRunCount, getTitleAt, getToolTipText, getToolTipTextAt, getUI, getUIClassID, indexAtLocation, indexOfComponent, indexOfTab, indexOfTab, indexOfTabComponent, isEnabledAt, paramString, remove, remove, removeAll, removeChangeListener, removeTabAt, setBackgroundAt, setComponentAt, setDisabledIconAt, setDisplayedMnemonicIndexAt, setEnabledAt, setForegroundAt, setIconAt, setMnemonicAt, setModel, setSelectedComponent, setSelectedIndex, setTabComponentAt, setTabLayoutPolicy, setTabPlacement, setTitleAt, setToolTipTextAt, 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, 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

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, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

XdevTabbedPane

public XdevTabbedPane()

Creates an empty TabbedPane with a default tab placement of JTabbedPane.TOP.

XdevTabbedPane

public XdevTabbedPane(int tabPlacement)

Creates an empty TabbedPane with the specified tab placement of either: JTabbedPane.TOP, JTabbedPane.BOTTOM, JTabbedPane.LEFT, or JTabbedPane.RIGHT.

Parameters:

tabPlacement - the placement for the tabs relative to the content

XdevTabbedPane

public XdevTabbedPane(int tabPlacement,
                      int tabLayoutPolicy)
               throws IllegalArgumentException

Creates an empty TabbedPane with the specified tab placement and tab layout policy. Tab placement may be either: JTabbedPane.TOP, JTabbedPane.BOTTOM, JTabbedPane.LEFT, or JTabbedPane.RIGHT. Tab layout policy may be either: JTabbedPane.WRAP_TAB_LAYOUT or JTabbedPane.SCROLL_TAB_LAYOUT.

Parameters:

tabPlacement - the placement for the tabs relative to the content

tabLayoutPolicy - the policy for laying out tabs when all tabs will not fit on one run

Throws:

IllegalArgumentException - if tab placement or tab layout policy are not one of the above supported values

Method Detail

addTab

public void addTab(XdevTab tab)
            throws NullPointerException

Adds a XdevTab to the this XdevTabbedPane.

Parameters:

tab - the XdevTab to add

Throws:

NullPointerException - if tab is null

insertTab

public void insertTab(String title,
                      Icon icon,
                      Component component,
                      String tip,
                      int index)

Overrides:

insertTab in class JTabbedPane

getTabAt

public Component getTabAt(int index)
                   throws IndexOutOfBoundsException

Returns the component at index.

Parameters:

index - the index of the item being queried

Returns:

the Component at index

Throws:

IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)

toString

public String toString()

Overrides:

toString in class Component

add

public Component add(Component comp)

Use addTab(XdevTab) to add a XdevTab to the XdevTabbedPane. If use one of the "add" methods the XdevTab will not be displayed as tab.

This method is only overridden to place a hint related to the use of the addTab(XdevTab) method.

Overrides:

add in class JTabbedPane

add

public Component add(Component comp,
                     int index)

Use addTab(XdevTab) to add a XdevTab to the XdevTabbedPane. If use one of the "add" methods the XdevTab will not be displayed as tab.

This method is only overridden to place a hint related to the use of the addTab(XdevTab) method.

Overrides:

add in class JTabbedPane

add

public void add(Component comp,
                Object constraints)

Use addTab(XdevTab) to add a XdevTab to the XdevTabbedPane. If use one of the "add" methods the XdevTab will not be displayed as tab.

This method is only overridden to place a hint related to the use of the addTab(XdevTab) method.

Overrides:

add in class JTabbedPane

add

public void add(Component comp,
                Object constraints,
                int index)

Use addTab(XdevTab) to add a XdevTab to the XdevTabbedPane. If use one of the "add" methods the XdevTab will not be displayed as tab.

This method is only overridden to place a hint related to the use of the addTab(XdevTab) method.

Overrides:

add in class JTabbedPane

add

public Component add(String name,
                     Component comp)

Use addTab(XdevTab) to add a XdevTab to the XdevTabbedPane. If use one of the "add" methods the XdevTab will not be displayed as tab.

This method is only overridden to place a hint related to the use of the addTab(XdevTab) method.

Overrides:

add in class JTabbedPane

loadPersistentState

public void loadPersistentState(String persistentState)

Restores this Components persistent state.

By calling this method, the passed state information get interpreted and applied on the affected attributes.

Specified by:

loadPersistentState in interface Persistable

Parameters:

persistentState - String representation for the persistent state of the Component.

See Also:

savePersistentState()

savePersistentState

public String savePersistentState()

Generates a String representation of this Components persistent state and returns it for being stored.

Persisted properties:

• selected index

Specified by:

savePersistentState in interface Persistable

Returns:

a String containing persistent state

getPersistentId

public String getPersistentId()

Uses the name of the component as a persistent id.

If no name is specified the name of the class will be used. This will work only for one persistent instance of the class!

Return a persistent id for this Component.

The following requirements have to be met for the persistent id:

• it has to be unique within the current application
• it has to be indentical across multiple invocations of the application

Specified by:

getPersistentId in interface Persistable

Returns:

a persistent id

isPersistenceEnabled

public boolean isPersistenceEnabled()

Flag, indicates, if the gui state for this component should be persisted.

Specified by:

isPersistenceEnabled in interface Persistable

Returns:

true if a instance of type Persistable is to be persisted.

setPersistenceEnabled

public void setPersistenceEnabled(boolean persistenceEnabled)

Sets the persistenceEnabled flag.

Parameters:

persistenceEnabled - the state for this instance