org.PingOO.DLAI.lib.PWidget
Class PScrollPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JScrollPane
                          |
                          +--org.PingOO.DLAI.lib.PWidget.PScrollPane
Direct Known Subclasses:
HtmlBrowser.HtmlViewer, HtmlViewer

public class PScrollPane
extends javax.swing.JScrollPane
implements PComponent

Provides a scroll pane that is localized tool tip capable.

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

Inner classes inherited from class javax.swing.JScrollPane
javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar
 
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
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 scroll pane's text and tool tip.
protected  java.lang.String toolTipKey
          Defines the key used to find this scroll pane's tool tip.
 
Fields inherited from class javax.swing.JScrollPane
columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, uiClassID, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport, viewportBorder
 
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
PScrollPane()
          Creates a new empty (no viewport view) scroll pane that has localized capabilities where both horizontal and vertical scrollbars appear when needed.
PScrollPane(java.awt.Component view)
          Creates a scroll pane that has localized capabilities, that displays the contents of the specified component, where both horizontal and vertical scrollbars appear whenever the component's contents are larger than the view.
PScrollPane(java.lang.String toolTipKey)
          Creates a new empty (no viewport view) scroll pane that has localized capabilities where both horizontal and vertical scrollbars appear when needed.
PScrollPane(java.lang.String toolTipKey, java.lang.String module)
          Creates a new empty (no viewport view) scroll pane that has localized capabilities, where both horizontal and vertical scrollbars appear when needed.
PScrollPane(java.lang.String toolTipKey, java.lang.String module, java.awt.Component view)
          Creates a scroll pane that has localized capabilities, that displays the contents of the specified component, where both horizontal and vertical scrollbars appear whenever the component's contents are larger than the view.
PScrollPane(java.lang.String toolTipKey, java.lang.String module, java.awt.Component view, int vsbPolicy, int hsbPolicy)
          Creates a scroll pane that has localized capabilities, that displays the view component in a viewport whose view position can be controlled with a pair of scrollbars.
PScrollPane(java.lang.String toolTipKey, java.lang.String module, int vsbPolicy, int hsbPolicy)
          Creates an empty (no viewport view) scroll pane that has localized capabilities, with specified scrollbar policies.
 
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 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.JScrollPane
createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isOpaque, isValidateRoot, paramString, setColumnHeader, setColumnHeaderView, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, 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, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, 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
add, add, add, add, add, 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, 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, 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 scroll pane's tool tip.

module

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

manager

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

PScrollPane

public PScrollPane()
Creates a new empty (no viewport view) scroll pane that has localized capabilities where both horizontal and vertical scrollbars appear when needed.

PScrollPane

public PScrollPane(java.lang.String toolTipKey)
Creates a new empty (no viewport view) scroll pane that has localized capabilities where both horizontal and vertical scrollbars appear when needed.
Parameters:
toolTipKey - The key used to get the localized tool tip.

PScrollPane

public PScrollPane(java.lang.String toolTipKey,
                   java.lang.String module)
Creates a new empty (no viewport view) scroll pane that has localized capabilities, where both horizontal and vertical scrollbars appear when needed.
Parameters:
toolTipKey - The key used to get the localized tool tip.
module - The module from which are loaded localized resources.

PScrollPane

public PScrollPane(java.awt.Component view)
Creates a scroll pane that has localized capabilities, that displays the contents of the specified component, where both horizontal and vertical scrollbars appear whenever the component's contents are larger than the view.
Parameters:
view - The Component to display in the scrollpanes viewport.

PScrollPane

public PScrollPane(java.lang.String toolTipKey,
                   java.lang.String module,
                   java.awt.Component view)
Creates a scroll pane that has localized capabilities, that displays the contents of the specified component, where both horizontal and vertical scrollbars appear whenever the component's contents are larger than the view.
Parameters:
toolTipKey - The key used to get the localized tool tip.
module - The module from which are loaded localized resources.
view - The Component to display in the scrollpanes viewport.

PScrollPane

public PScrollPane(java.lang.String toolTipKey,
                   java.lang.String module,
                   int vsbPolicy,
                   int hsbPolicy)
Creates an empty (no viewport view) scroll pane that has localized capabilities, with specified scrollbar policies.
Parameters:
toolTipKey - The key used to get the localized tool tip.
module - The module from which are loaded localized resources.
vsbPolicy - An int that specifies the vertical scrollbar policy.
hsbPolicy - An int that specifies the horizontal scrollbar policy.

PScrollPane

public PScrollPane(java.lang.String toolTipKey,
                   java.lang.String module,
                   java.awt.Component view,
                   int vsbPolicy,
                   int hsbPolicy)
Creates a scroll pane that has localized capabilities, that displays the view component in a viewport whose view position can be controlled with a pair of scrollbars.
Parameters:
toolTipKey - The key used to get the localized tool tip.
module - The module from which are loaded localized resources.
view - The Component to display in the scrollpanes viewport.
vsbPolicy - An int that specifies the vertical scrollbar policy.
hsbPolicy - An int that specifies the horizontal scrollbar policy.
Method Detail

updateFont

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

updateLanguage

public void updateLanguage()
Updates the language of the interface.
Specified by:
updateLanguage in interface PComponent

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.

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.

updateLanguage

public void updateLanguage(java.lang.String module)
Updates the language of the interface.
Specified by:
updateLanguage in interface PComponent
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
Specified by:
getTextKey in interface PComponent
Returns:
The key used to find this scroll pane'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.
Specified by:
getToolTipKey in interface PComponent
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.
Specified by:
getModule in interface PComponent
Returns:
The component's resources location or PComponent.DEFAULT_MODULE if the component has no defined module