org.PingOO.DLAI.lib.PWidget
Class PInternalFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JInternalFrame
                          |
                          +--org.PingOO.DLAI.lib.PWidget.PInternalFrame
Direct Known Subclasses:
HelpInternalFrame, InternalMessage, PInternalDialog, PPM.AboutInternalFrame, PSlave, PTool

public class PInternalFrame
extends javax.swing.JInternalFrame
implements PGUI

Here are defined the common shared methods between all gui interfaces.
An InternalFrame is, well, is a complete window with borders and a title bar included inside a JDesktopPane.
The InternalFrame remains on top of its root JDesktopPane.

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

Inner Class Summary
protected  class PInternalFrame.PInternalMouseInputListener
          Default mouse listener used to track the mouse over this internal frame.
 
Inner classes inherited from class javax.swing.JInternalFrame
javax.swing.JInternalFrame.AccessibleJInternalFrame, javax.swing.JInternalFrame.JDesktopIcon
 
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
 javax.swing.event.MouseInputListener defaultMouseInputListener
          The default mouse adapter used to track the mouse over this internal frame.
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 internal frame's text and tool tip.
protected  java.lang.String titleKey
          Defines the key used to find this internal frame's title.
protected  java.lang.String toolTipKey
          Defines the key used to find this internal frame's tool tip.
 
Fields inherited from class javax.swing.JInternalFrame
closable, CONTENT_PANE_PROPERTY, defaultCloseOperation, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, opened, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY, 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
PInternalFrame()
          Creates a new internal frame for the interface.
PInternalFrame(java.lang.String titleKey)
          Creates a new internal frame for the interface.
PInternalFrame(java.lang.String titleKey, boolean resizable)
          Creates a new internal frame for the interface.
PInternalFrame(java.lang.String titleKey, boolean resizable, boolean closable)
          Creates a new internal frame for the interface.
PInternalFrame(java.lang.String titleKey, boolean resizable, boolean closable, boolean maximizable)
          Creates a new internal frame for the interface.
PInternalFrame(java.lang.String titleKey, boolean resizable, boolean closable, boolean maximizable, boolean iconifiable)
          Creates a new internal frame for the interface.
PInternalFrame(java.lang.String titleKey, java.lang.String toolTipKey, java.lang.String module, boolean resizable, boolean closable, boolean maximizable, boolean iconifiable)
          Creates a new internal frame for the interface.
 
Method Summary
 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 internal frame's tool tip.
 void setLocalizedTitle(java.lang.String titleKey)
          Registers the internal frame title.
 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 updateFont()
          Update the component's font.
 void updateLanguage()
          Updates the language of the interface.
 void updateLanguage(java.lang.String module)
          Updates the language of the interface.
 
Methods inherited from class javax.swing.JInternalFrame
addImpl, addInternalFrameListener, createRootPane, createRootPaneException, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getBackground, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getForeground, getFrameIcon, getGlassPane, getJMenuBar, getLayer, getLayeredPane, getMenuBar, getRootPane, getTitle, getUI, getUIClassID, getWarningString, isClosable, isClosed, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paramString, removeInternalFrameListener, reshape, setBackground, setClosable, setClosed, setContentPane, setDefaultCloseOperation, setDesktopIcon, setForeground, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, setVisible, show, startModal, stopModal, toBack, toFront, updateUI, updateUIWhenHidden, 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, getSize, getToolTipLocation, getToolTipText, 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, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFlag, setFont, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, shouldDebugGraphics, superProcessMouseMotionEvent, unregisterKeyboardAction, unregisterWithKeyboardManager, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, removeAll, removeContainerListener, setFocusOwner, 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, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont_NoClientCode, getFont, getFontMetrics, 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, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

titleKey

protected java.lang.String titleKey
Defines the key used to find this internal frame's title.

toolTipKey

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

module

protected java.lang.String module
Defines the module where to find this internal frame's text and tool tip.

manager

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

defaultMouseInputListener

public final javax.swing.event.MouseInputListener defaultMouseInputListener
The default mouse adapter used to track the mouse over this internal frame.
Constructor Detail

PInternalFrame

public PInternalFrame()
Creates a new internal frame for the interface.
Creates a non-resizable, non-closable, non-maximizable, non-iconifiable PInternalFrame with default title.
The default title is provided for the motif look and feel which seems to crash when an internal fram does not have a title.

PInternalFrame

public PInternalFrame(java.lang.String titleKey)
Creates a new internal frame for the interface.
Creates a non-resizable, non-closable, non-maximizable, non-iconifiable PInternalFrame with the specified title.
Parameters:
titleKey - The key used to get the localized title.

PInternalFrame

public PInternalFrame(java.lang.String titleKey,
                      boolean resizable)
Creates a new internal frame for the interface.
Creates a non-closable, non-maximizable, non-iconifiable PInternalFrame with the specified title and with resizability specified.
Parameters:
titleKey - The key used to get the localized title.
resizable - Indicates if the internal frame is resizable or not.

PInternalFrame

public PInternalFrame(java.lang.String titleKey,
                      boolean resizable,
                      boolean closable)
Creates a new internal frame for the interface.
Creates a non-maximizable, non-iconifiable PInternalFrame with the specified title and with resizability and closability specified.
Parameters:
titleKey - The key used to get the localized title.
resizable - Indicates if the internal frame is resizable or not.
closable - Indicates if the internal frame is closable or not.

PInternalFrame

public PInternalFrame(java.lang.String titleKey,
                      boolean resizable,
                      boolean closable,
                      boolean maximizable)
Creates a new internal frame for the interface.
Creates a non-iconifiable PInternalFrame with the specified title and with resizability, closability, and maximizability specified.
Parameters:
titleKey - The key used to get the localized title.
resizable - Indicates if the internal frame is resizable or not.
closable - Indicates if the internal frame is closable or not.
maximizable - Indicates if the internal frame is maximizable or not.

PInternalFrame

public PInternalFrame(java.lang.String titleKey,
                      boolean resizable,
                      boolean closable,
                      boolean maximizable,
                      boolean iconifiable)
Creates a new internal frame for the interface.
Creates a PInternalFrame with the specified title and with resizability, closability, maximizability, and iconifiability specified.
Parameters:
titleKey - The key used to get the localized title.
resizable - Indicates if the internal frame is resizable or not.
closable - Indicates if the internal frame is closable or not.
maximizable - Indicates if the internal frame is maximizable or not.
iconifiable - Indicates if the internal frame is iconifiable or not.

PInternalFrame

public PInternalFrame(java.lang.String titleKey,
                      java.lang.String toolTipKey,
                      java.lang.String module,
                      boolean resizable,
                      boolean closable,
                      boolean maximizable,
                      boolean iconifiable)
Creates a new internal frame for the interface.
Creates a PInternalFrame with the specified title and with resizability, closability, maximizability, and iconifiability specified.
Parameters:
titleKey - The key used to get the localized title.
toolTipKey - The key used to get the localized tool tip.
module - The module used to load localized resources.
resizable - Indicates if the internal frame is resizable or not.
closable - Indicates if the internal frame is closable or not.
maximizable - Indicates if the internal frame is maximizable or not.
iconifiable - Indicates if the internal frame is iconifiable or not.
Method Detail

setManager

public void setManager(PManager manager)
Sets the manager of this component.
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.
Returns:
The manager of this component.

setModule

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

setLocalizedTitle

public void setLocalizedTitle(java.lang.String titleKey)
Registers the internal frame title.
Parameters:
titlKey - The key used to get the localized title.

setLocalizedToolTipText

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

updateFont

public void updateFont()
Update the component's font.

updateLanguage

public void updateLanguage()
Updates the language of the interface.

updateLanguage

public void updateLanguage(java.lang.String module)
Updates the language of the interface.
Parameters:
module - The module from which are loaded localized resources.

getTextKey

public java.lang.String getTextKey()
Returns the key used to find this component's text
Returns:
The key used to find this internal frame's text, null if the component does not support text.

getToolTipKey

public java.lang.String getToolTipKey()
Returns the key used to find this internal frame's tool tip.
Returns:
The key used to find this internal frame's tool tip, null if the component does not support tool tip.

getModule

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