org.PingOO.DLAI.lib.PWidget
Class PTabbedPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JTabbedPane
                          |
                          +--org.PingOO.DLAI.lib.PWidget.PTabbedPane

public final class PTabbedPane
extends javax.swing.JTabbedPane
implements PComponent

Provides a tabbed pane that is localized text and localized tool tip capable.

Since:
PingOO 2.0
Version:
2.0
Author:
Fabrice Bouyé (bouye@cur-archamps.fr)
See Also:
JTabbedPane, PComponent, Serialized Form

Inner classes inherited from class javax.swing.JTabbedPane
javax.swing.JTabbedPane.AccessibleJTabbedPane, javax.swing.JTabbedPane.ModelListener
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent, javax.swing.JComponent.IntVector, javax.swing.JComponent.KeyboardBinding, javax.swing.JComponent.KeyboardState
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AWTTreeLock
 
Field Summary
protected  java.util.Hashtable indexList
          Store all text keys for tabs that include PComponent.
private  PManager manager
          The manager where this component will lokk for its resources.
protected  java.lang.String module
          Defines the module where to find this tabbed pane's tool tip.
protected  java.lang.String toolTipKey
          Defines the key used to find this tabbed pane's tool tip.
 
Fields inherited from class javax.swing.JTabbedPane
changeEvent, changeListener, haveRegistered, model, pages, tabPlacement, uiClassID
 
Fields inherited from class javax.swing.JComponent
_bounds, accessibleContext, alignmentX, alignmentY, ANCESTOR_USING_BUFFER, ancestorNotifier, autoscroller, border, changeSupport, clientProperties, flags, HAS_FOCUS, IS_DOUBLE_BUFFERED, IS_OPAQUE, IS_PAINTING_TILE, KEYBOARD_BINDINGS_KEY, listenerList, maximumSize, minimumSize, NEXT_FOCUS, paintImmediatelyClip, preferredSize, readObjectCallbacks, REQUEST_FOCUS_DISABLED, tmpRect, TOOL_TIP_TEXT_KEY, ui, uiClassID, UNDEFINED_CONDITION, vetoableChangeSupport, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
component, containerListener, containerSerializedDataVersion, dispatcher, layoutMgr, maxSize, ncomponents, serialVersionUID
 
Fields inherited from class java.awt.Component
actionListenerK, adjustmentListenerK, appContext, assert, background, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, changeSupport, componentListener, componentListenerK, componentOrientation, componentSerializedDataVersion, containerListenerK, cursor, dropTarget, enabled, eventMask, focusListener, focusListenerK, font, foreground, hasFocus, height, incRate, inputMethodListener, inputMethodListenerK, isInc, isPacked, itemListenerK, keyListener, keyListenerK, LEFT_ALIGNMENT, locale, LOCK, minSize, mouseListener, mouseListenerK, mouseMotionListener, mouseMotionListenerK, name, nameExplicitlySet, newEventsOnly, ownedWindowK, parent, peer, peerFont, popups, prefSize, RIGHT_ALIGNMENT, serialVersionUID, textListenerK, TOP_ALIGNMENT, valid, visible, width, windowListenerK, x, y
 
Constructor Summary
PTabbedPane()
          Creates an empty tabbed pane.
PTabbedPane(java.lang.String toolTipKey)
          Creates an empty tabbed pane.
PTabbedPane(java.lang.String toolTipKey, java.lang.String module)
          Creates an empty tabbed pane.
PTabbedPane(java.lang.String toolTipKey, java.lang.String module, int tabPlacement)
          Creates an empty tabbed pane.
 
Method Summary
 java.awt.Component add(PComponent component)
          Adds a PComponent with a tab title defaulting to the name of the component.
 java.awt.Component add(java.lang.String titleKey, java.awt.Component component)
          Adds a Component (which does not provide a localized text) with a tab title.
 java.awt.Component addLocalizedComponent(java.lang.String titleKey, PComponent component)
          Adds a PComponent with a tab title defaulting to the name of the component.
 PManager getManager()
          Returns the manager of this component.
 java.lang.String getModule()
          Returns the component's resources location.
 java.lang.String getTextKey()
          Returns the key used to find this component's text
 java.lang.String getToolTipKey()
          Returns the key used to find this button's tool tip.
 int indexOfTab(java.lang.String titleKey)
          Returns the first tab index with a given title.
 void remove(PComponent component)
          Removes the tab which corresponds to the specified component.
 void removeAll()
          Removes all the tabs from the tabbedpane.
 void setLocalizedToolTipText(java.lang.String toolTipKey)
          Registers the text to display in a tool tip.
 void setManager(PManager manager)
          Sets the manager of this component.
 void setModule(java.lang.String module)
          Sets The module where the component will search its resources
 void setTitleKeyAt(int index, java.lang.String titleKey)
          Sets the title at index with a titleKey which can be null.
 void updateFont()
          Update the component's font.
 void updateLanguage()
          Update the tabbed pane's title and tool tip with the default module.
 void updateLanguage(java.lang.String module)
          Update the tabbed pane's text and tool tip with the current module.
 
Methods inherited from class javax.swing.JTabbedPane
add, add, add, add, addChangeListener, addTab, addTab, addTab, createChangeListener, fireStateChanged, getAccessibleContext, getBackgroundAt, getBoundsAt, getComponentAt, getDisabledIconAt, getForegroundAt, getIconAt, getModel, getSelectedComponent, getSelectedIndex, getTabCount, getTabPlacement, getTabRunCount, getTitleAt, getToolTipText, getUI, getUIClassID, indexOfComponent, indexOfTab, insertTab, isEnabledAt, paramString, remove, removeChangeListener, removeTabAt, setBackgroundAt, setComponentAt, setDisabledIconAt, setEnabledAt, setForegroundAt, setIconAt, setModel, setSelectedComponent, setSelectedIndex, setTabPlacement, setTitleAt, setUI, updateUI, writeObject
 
Methods inherited from class javax.swing.JComponent
_paintImmediately, , addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, adjustPaintFlags, alwaysOnTop, bindingForKeyStroke, computeVisibleRect, computeVisibleRect, contains, createToolTip, enableSerialization, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperties, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getFlag, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, keyboardBindings, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paintWithBuffer, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyBindings, processKeyBindingsForAllComponents, processKeyEvent, processMouseMotionEvent, putClientProperty, readObject, rectangleIsObscured, registerKeyboardAction, registerKeyboardAction, registerWithKeyboardManager, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFlag, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, shouldDebugGraphics, superProcessMouseMotionEvent, unregisterKeyboardAction, unregisterWithKeyboardManager, update
 
Methods inherited from class java.awt.Container
addContainerListener, addImpl, applyOrientation, countComponents, deliverEvent, dispatchEventImpl, dispatchEventToSelf, doLayout, eventEnabled, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents_NoClientCode, getComponents, getLayout, getMouseEventTarget, getWindow, initIDs, insets, invalidate, invalidateTree, isAncestorOf, layout, lightweightPrint, list, list, locate, minimumSize, nextFocus, paintComponents, postProcessKeyEvent, postsOldMouseEvents, preferredSize, preProcessKeyEvent, print, printComponents, printOneComponent, processContainerEvent, processEvent, proxyEnableEvents, proxyRequestFocus, remove, removeContainerListener, setFocusOwner, setLayout, transferFocus, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, areInputMethodsEnabled, bounds, checkImage, checkImage, coalesceEvents, constructComponentName, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont_NoClientCode, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getNativeContainer, getParent_NoClientCode, getParent, getPeer, getSize, getToolkit, getToolkitImpl, getTreeLock, getWindowForObject, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isEnabledImpl, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

toolTipKey

protected java.lang.String toolTipKey
Defines the key used to find this tabbed pane's tool tip.

module

protected java.lang.String module
Defines the module where to find this tabbed pane's tool tip.

manager

private PManager manager
The manager where this component will lokk for its resources.

indexList

protected final java.util.Hashtable indexList
Store all text keys for tabs that include PComponent.
Constructor Detail

PTabbedPane

public PTabbedPane()
Creates an empty tabbed pane.

PTabbedPane

public PTabbedPane(java.lang.String toolTipKey)
Creates an empty tabbed pane.
Parameters:
toolTipKey - The key needed to retrieve the button's tool tip.

PTabbedPane

public PTabbedPane(java.lang.String toolTipKey,
                   java.lang.String module)
Creates an empty tabbed pane.
Parameters:
toolTipKey - The key needed to retrieve the button's tool tip.
module - The module where to find the resources.

PTabbedPane

public PTabbedPane(java.lang.String toolTipKey,
                   java.lang.String module,
                   int tabPlacement)
Creates an empty tabbed pane.
Parameters:
toolTipKey - The key needed to retrieve the button's tool tip.
module - The module where to find the resources.
tabPlacement - The placement for the tabs relative to the content.
Method Detail

setLocalizedToolTipText

public final void setLocalizedToolTipText(java.lang.String toolTipKey)
Registers the text to display in a tool tip. The text displays when the cursor lingers over the component.
Parameters:
toolTipKey - The key used to get the localized tool tip.

add

public java.awt.Component add(PComponent component)
Adds a PComponent with a tab title defaulting to the name of the component. Cover method for insertTab().
Parameters:
component - The component to be displayed when this tab is clicked.

addLocalizedComponent

public java.awt.Component addLocalizedComponent(java.lang.String titleKey,
                                                PComponent component)
Adds a PComponent with a tab title defaulting to the name of the component.
Parameters:
titleKey - The string to get the localized title of this tab.
component - The component to be displayed when this tab is clicked.

add

public java.awt.Component add(java.lang.String titleKey,
                              java.awt.Component component)
Adds a Component (which does not provide a localized text) with a tab title.
Parameters:
titleKey - The string to get the localized title of this tab.
component - The component to be displayed when this tab is clicked.
Overrides:
add in class javax.swing.JTabbedPane

remove

public void remove(PComponent component)
Removes the tab which corresponds to the specified component.
Parameters:
component - The component to remove from the tabbedpane.

removeAll

public void removeAll()
Removes all the tabs from the tabbedpane.
Overrides:
removeAll in class javax.swing.JTabbedPane

updateFont

public void updateFont()
Update the component's font.
Specified by:
updateFont in interface PComponent

updateLanguage

public void updateLanguage()
Update the tabbed pane's title and tool tip with the default module.
Specified by:
updateLanguage in interface PComponent

updateLanguage

public void updateLanguage(java.lang.String module)
Update the tabbed pane's text and tool tip with the current module.
Specified by:
updateLanguage in interface PComponent
Parameters:
module - The module where the resources are stored.

setTitleKeyAt

public final void setTitleKeyAt(int index,
                                java.lang.String titleKey)
Sets the title at index with a titleKey which can be null.
Parameters:
index - The tab index where the title should be set.
titleKey - The key needed to find this tab's title.

setManager

public void setManager(PManager manager)
Sets the manager of this component.
Specified by:
setManager in interface PComponent
Parameters:
manager - the new manager of this component, if manager is null, the component will use PManager.getInstance().

getManager

public PManager getManager()
Returns the manager of this component.
Specified by:
getManager in interface PComponent
Returns:
The manager of this component.

setModule

public void setModule(java.lang.String module)
Sets The module where the component will search its resources
Specified by:
setModule in interface PComponent
Parameters:
module - The new module. If null, the default resource set will be used.

getTextKey

public java.lang.String getTextKey()
Returns the key used to find this component's text
Specified by:
getTextKey in interface PComponent
Returns:
The key used to find this button's text, null if the component does not support text.

getToolTipKey

public java.lang.String getToolTipKey()
Returns the key used to find this button's tool tip.
Specified by:
getToolTipKey in interface PComponent
Returns:
The key used to find this button's tool tip, null if the component does not support tool tip.

getModule

public java.lang.String getModule()
Returns the component's resources location.
Specified by:
getModule in interface PComponent
Returns:
The component's resources location or PComponent.DEFAULT_MODULE if the component has no defined module

indexOfTab

public int indexOfTab(java.lang.String titleKey)
Returns the first tab index with a given title.
Returns -1 if no tab has this title.
Parameters:
titleKey - The titleKey for the tab.
Returns:
The first tab index with a given title, returns -1 if no tab has this title.
Overrides:
indexOfTab in class javax.swing.JTabbedPane