se.entra.phantom.client

Class PJUserWindow

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

se.entra.phantom.client.PJUserWindow

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

PHED_AVAILABLECOLORS, PHPSB_PSBLOADING, RCONSOLE_AVAILABLECOLORS, RCONSOLE_COLORCHOOSER, RCONSOLE_FILEMANAGER, RCONSOLE_FILETRANSFER, RCONSOLE_FONTMETRICS, RCONSOLE_HTML, RCONSOLE_JMXRMI, RCONSOLE_LISTHEADERCOLOR, RCONSOLE_PROGRESSBAR, RCONSOLE_TERMINAL

public abstract class PJUserWindow
extends JComponent

All user windows in the Client should extend from this class. Note that if tab handling is required, override the method isFocusTraversable and return true.

See Also:

Serialized Form

Nested Class Summary

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
PJUserWindow(CUserWindow uw, byte[] data) Constructs the user window.

Method Summary

Modifier and Type	Method and Description
void	create(Transaction trans) The server user window has a transaction for the client user window.
void	dispose() The dispose method is called when the panel already has been disposed of.
URL	getCodeBase() Gets the current code base.
Image	getImage(String s) Gets the image with a full URL.
ImageIcon	getImage(String name, boolean keepInCache) Returns an ImageIcon object that can then be painted on the screen.
Image	getImage(URL u, String s) Gets the image "s" of an URL.
PPanel	getPPanel() Gets the instance of the Phantom Panel data that is used to issueActionEvent's.
CUserWindow	getUserWindow() Gets the user window data instance.
boolean	isFocusTraversable() This component doesn't handle or want focus, so return false.
void	issueUpdate(Transaction trans) This method is called by the panel for all controls.
void	play(URL u) Plays a URL sound.
void	play(URL u, String s) Plays a sound "s" of an URL.
boolean	setFocus(KeyEvent event) Sets the focus to the control in question.
void	update(Transaction trans) If the server implements a user window and this has caused updates, this method is called.
void	updateStates() This method is always called at the end of the creation of all components.

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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI

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, getAccessibleContext, 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, 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

PJUserWindow

public PJUserWindow(CUserWindow uw,
                    byte[] data)

Constructs the user window. The data is user window specific. If the server also implements a user window, the create method will be called just after this.

Method Detail

create

public void create(Transaction trans)

The server user window has a transaction for the client user window.

dispose

public void dispose()

The dispose method is called when the panel already has been disposed of.

updateStates

public void updateStates()

This method is always called at the end of the creation of all components. It may be used to access other components in the panel in order to update states of this particular component.

update

public void update(Transaction trans)

If the server implements a user window and this has caused updates, this method is called.

issueUpdate

public void issueUpdate(Transaction trans)

This method is called by the panel for all controls. The data must be a transaction of changes only. The method is only called for user windows implemented on the server. Use the "Transaction.appendNnn" methods to fill in the transaction with data.

isFocusTraversable

public boolean isFocusTraversable()

This component doesn't handle or want focus, so return false.

Overrides:

isFocusTraversable in class Component

getUserWindow

public CUserWindow getUserWindow()

Gets the user window data instance.

getPPanel

public PPanel getPPanel()

Gets the instance of the Phantom Panel data that is used to issueActionEvent's.

setFocus

public boolean setFocus(KeyEvent event)

Sets the focus to the control in question.

Parameters:

event - The key event causing the focus change. This parameter may be null if no special key event caused the focus change, rather a direct call to change the focus using the method PFocusManager.focusControl(PControl).

Returns:

true If focus is changed by the control,
false Will cause focus manager to call JComponent.grabFocus.

play

public void play(URL u)

Plays a URL sound.

play

public void play(URL u,
                 String s)

Plays a sound "s" of an URL.

getImage

public Image getImage(URL u,
                      String s)

Gets the image "s" of an URL.

Returns:

null if the image is not found.

getImage

public Image getImage(String s)

Gets the image with a full URL.

Returns:

null if the image is not found.

getImage

public ImageIcon getImage(String name,
                          boolean keepInCache)

Returns an ImageIcon object that can then be painted on the screen.

Parameters:

name - the location of the image, relative to the url argument.

keepInCache - flag specifying if the image should be cached or not.

Returns:

ImageIcon the Swing image icon of the specified name or null if not found.

getCodeBase

public URL getCodeBase()

Gets the current code base.