org.openide.windows

Class TopComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.openide.windows.TopComponent

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Externalizable, java.io.Serializable, javax.accessibility.Accessible

public class TopComponent
extends javax.swing.JComponent
implements java.io.Externalizable, javax.accessibility.Accessible

Embeddable visual component to be displayed in the IDE. This is the basic unit of display in the IDE--windows should not be created directly, but rather use this class. A top component may correspond to a single window, but may also be a tab (e.g.) in a window. It may be docked or undocked, have selected nodes, supply actions, etc. Important serialization note: Serialization of this TopComponent is designed in a way that it's not desired to override writeReplace method. If you would like to resolve to something, please implement readResolve() method directly on your top component.

Author:

Jaroslav Tulach, Petr Hamernik, Jan Jancura

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TopComponent.Cloneable Each top component that wishes to be cloned should implement this interface, so CloneAction can check it and call the cloneComponent method.
static class	TopComponent.NodeName This class provides the connection between the node name and a name of the component.
static interface	TopComponent.Registry Registry of all top components.

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

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSE_EACH Behavior in which a top component closed (by the user) in one workspace will be removed from every workspace.
static int	CLOSE_LAST Behavior in which a top component closed (by the user) in one workspace may be left in other workspaces.

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
TopComponent() Create a top component.

Method Summary

Modifier and Type	Method and Description
void	addNotify()
java.util.List	availableModes(java.util.List modes) Allows top component to specify list of modes into which can be docked by end user.
boolean	canClose(Workspace workspace, boolean last) This method is called when top component is about to close.
boolean	close() Closes the top component on current workspace.
boolean	close(Workspace workspace) Closes the top component on given workspace, if closeOperation is set to CLOSE_LAST.
protected void	closeNotify() Deprecated. Use componentClosed() instead.
protected void	componentActivated() Called when this component is activated.
protected void	componentClosed() Called only when top component was closed so that now it is closed on all workspaces in the system.
protected void	componentDeactivated() Called when this component is deactivated.
protected void	componentHidden() Called when TopComponent was hidden.
protected void	componentOpened() Called only when top component was closed on all workspaces before and now is opened for the first time on some workspace.
protected void	componentShowing() Called when TopComponent is about to be shown.
javax.accessibility.AccessibleContext	getAccessibleContext()
javax.swing.Action[]	getActions() Gets the actions which will appear in the popup menu of this component.
Node[]	getActivatedNodes() Get the set of activated nodes in this component.
int	getCloseOperation() Get the current close mode for this component.
HelpCtx	getHelpCtx() Get the help context for this component.
java.awt.Image	getIcon()
Lookup	getLookup() Gets lookup which represents context of this component.
static TopComponent.Registry	getRegistry() Getter for class that allows obtaining of information about components.
SystemAction[]	getSystemActions() Deprecated. Use getActions() instead.
UndoRedo	getUndoRedo() Get the undo/redo support for this component.
boolean	isOpened() Finds out if this top component is opened at least on one workspace.
boolean	isOpened(Workspace workspace) Finds out whether this top component is opened or not on specified workspace.
void	open() Show the component on current workspace.
void	open(Workspace workspace) Show the component on given workspace.
protected void	openNotify() Deprecated. Use componentOpened() instead.
void	readExternal(java.io.ObjectInput in) Deserialize this top component.
void	requestFocus() Request focus for the window holding this top component.
void	requestVisible() Set this component visible but not selected or focused if possible.
void	setActivatedNodes(Node[] nodes) Set the set of activated nodes in this component.
void	setCloseOperation(int closeOperation) Set the close mode for the component.
void	setIcon(java.awt.Image icon) Set the icon of this top component.
void	setName(java.lang.String name) Set the name of this top component.
void	setToolTipText(java.lang.String toolTip) Sets toolTip for this TopComponent, adds notification about the change to its WindowManager.TopComponentManager.
void	writeExternal(java.io.ObjectOutput out) Serialize this top component.
protected java.lang.Object	writeReplace() Delegates instance of replacer class to be serialized instead of top component itself.

Methods inherited from class javax.swing.JComponent

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

Field Detail

CLOSE_EACH

public static final int CLOSE_EACH

Behavior in which a top component closed (by the user) in one workspace will be removed from every workspace. Also, close() is called. This is appropriate for top components such as Editor panes which the user expects to really close (and prompt to save) when closed in any workspace.

See Also:

Constant Field Values

CLOSE_LAST

public static final int CLOSE_LAST

Behavior in which a top component closed (by the user) in one workspace may be left in other workspaces. Only when the last remaining manifestation in any workspace is closed will the object be deleted using close(). Appropriate for components containing no user data, for which closing the component is only likely to result from the user's wanting to remove it from active view (on the current workspace).

See Also:

Constant Field Values

Constructor Detail

TopComponent

public TopComponent()

Create a top component.

Method Detail

getRegistry

public static final TopComponent.Registry getRegistry()

Getter for class that allows obtaining of information about components. It allows to find out which component is selected, which nodes are currently or has been activated and list of all components.

Returns:

the registry of components

getActivatedNodes

public final Node[] getActivatedNodes()

Get the set of activated nodes in this component.

Returns:

the activated nodes for this component

setActivatedNodes

public final void setActivatedNodes(Node[] nodes)

Set the set of activated nodes in this component.

Parameters:

nodes - activated nodes for this component

getUndoRedo

public UndoRedo getUndoRedo()

Get the undo/redo support for this component. The default implementation returns a dummy support that cannot undo anything.

Returns:

undoable edit for this component

open

public void open()

Show the component on current workspace. Note that this method only makes it visible, but does not give it focus. Implemented via call to open(null).

See Also:

requestFocus()

open

public void open(Workspace workspace)

Show the component on given workspace. If given workspace is not active, component will be shown only after given workspace will become visible. Note that this method only makes it visible, but does not give it focus.

Parameters:

workspace - Workspace on which component should be opened. Parameter can be null -> means current workspace.

See Also:

requestFocus()

isOpened

public final boolean isOpened()

Finds out if this top component is opened at least on one workspace.

Returns:

true if given top component is opened on at least one workspace, false otherwise

isOpened

public final boolean isOpened(Workspace workspace)

Finds out whether this top component is opened or not on specified workspace.

Returns:

true if given top component is opened on given workspace, false otherwise

addNotify

public void addNotify()

Overrides:

addNotify in class javax.swing.JComponent

close

public final boolean close()

Closes the top component on current workspace. First asks canClose() method to see if it is possible to close now. If canClose() returns false, component will not be closed. Semantics of this method depends on top component's closeOperation state. If closeOperation is set to CLOSE_LAST (default), top component will be closed only on current workspace. If it is set to CLOSE_EACH, if will be closed on all workspaces at once.

Returns:

true if top component was succesfully closed, false if top component for some reason refused to close.

close

public final boolean close(Workspace workspace)

Closes the top component on given workspace, if closeOperation is set to CLOSE_LAST. If it is set to CLOSE_EACH, given parameter will be ignored and component will be closed on all workspaces at once.

Parameters:

workspace - Workspace on which component should be closed.

Returns:

true if top component was succesfully closed, false if top component for some reason refused to close.

canClose

public boolean canClose(Workspace workspace,
                        boolean last)

This method is called when top component is about to close. Allows subclasses to decide if top component is ready for closing or not.
Default implementation always return true.

Parameters:

workspace - the workspace on which we are about to close or null which means that component will be closed on all workspaces where it is opened (CLOSE_EACH mode)

last - true if this is last workspace where top component is opened, false otherwise. If close operation is set to CLOSE_EACH, then this param is always true

Returns:

true if top component is ready to close, false otherwise.

openNotify

protected void openNotify()

Deprecated. Use componentOpened() instead.

Called only when top component was closed on all workspaces before and now is opened for the first time on some workspace. The intent is to provide subclasses information about TopComponent's life cycle across all existing workspaces. Subclasses will usually perform initializing tasks here.

closeNotify

protected void closeNotify()

Deprecated. Use componentClosed() instead.

Called only when top component was closed so that now it is closed on all workspaces in the system. The intent is to provide subclasses information about TopComponent's life cycle across workspaces. Subclasses will usually perform cleaning tasks here.

getSystemActions

public SystemAction[] getSystemActions()

Deprecated. Use getActions() instead.

Gets the system actions which will appear in the popup menu of this component.

Returns:

array of system actions for this component

getActions

public javax.swing.Action[] getActions()

Gets the actions which will appear in the popup menu of this component.

Subclasses are encouraged to override this method to specify their own sets of actions.

Remember to call the super method when overriding and add your actions to the superclass' ones (in some order), because the default implementation provides support for standard component actions like save, close, and clone.

Returns:

array of actions for this component

Since:

3.32

setCloseOperation

public final void setCloseOperation(int closeOperation)

Set the close mode for the component.

Parameters:

closeOperation - one of CLOSE_EACH or CLOSE_LAST

Throws:

java.lang.IllegalArgumentException - if an unrecognized close mode was supplied

See Also:

close()

getCloseOperation

public final int getCloseOperation()

Get the current close mode for this component.

Returns:

one of CLOSE_EACH or CLOSE_LAST

componentOpened

protected void componentOpened()

Called only when top component was closed on all workspaces before and now is opened for the first time on some workspace. The intent is to provide subclasses information about TopComponent's life cycle across all existing workspaces. Subclasses will usually perform initializing tasks here.

Since:

2.18

componentClosed

protected void componentClosed()

Called only when top component was closed so that now it is closed on all workspaces in the system. The intent is to provide subclasses information about TopComponent's life cycle across workspaces. Subclasses will usually perform cleaning tasks here.

Since:

2.18

componentShowing

protected void componentShowing()

Called when TopComponent is about to be shown. Shown here means the component is selected or resides in it own cell in container in its Mode. The container is visible and not minimized.

Note: component is considered to be shown, even its container window is overlapped by another window.

Since:

2.18

componentHidden

protected void componentHidden()

Called when TopComponent was hidden. Nore:

Note: Beside typical situations when component is hidden, it is considered to be hidden even in that case the component is in Mode container hierarchy, the cointainer is visible, not minimized, but the component is neither selected nor in its own cell, i.e. it has it's own tab, but is not the selected one.

Since:

2.18

componentActivated

protected void componentActivated()

Called when this component is activated. This happens when the parent window of this component gets focus (and this component is the preferred one in it), or when this component is selected in its window (and its window was already focussed). Remember to call the super method. The default implementation does nothing.

componentDeactivated

protected void componentDeactivated()

Called when this component is deactivated. This happens when the parent window of this component loses focus (and this component is the preferred one in the parent), or when this component loses preference in the parent window (and the parent window is focussed). Remember to call the super method. The default implementation does nothing.

requestFocus

public void requestFocus()

Request focus for the window holding this top component. Also makes the component preferred in that window. The component will not be automatically opened first if it is not already.

Subclasses should override this method to transfer focus to desired focusable component. TopComponent itself is not focusable. See for example org.openide.text.CloneableEditor#requestFocus.

Overrides:

requestFocus in class javax.swing.JComponent

requestVisible

public void requestVisible()

Set this component visible but not selected or focused if possible. If focus is in other container (multitab) or other pane (split) in the same container it makes this component only visible eg. it selects tab with this component. If focus is in the same container (multitab) or in the same pane (split) it has the same effect as requestFocus().

setName

public void setName(java.lang.String name)

Set the name of this top component. The default implementation just notifies the window manager.

Overrides:

setName in class java.awt.Component

Parameters:

name - the new display name

setToolTipText

public void setToolTipText(java.lang.String toolTip)

Sets toolTip for this TopComponent, adds notification about the change to its WindowManager.TopComponentManager.

Overrides:

setToolTipText in class javax.swing.JComponent

setIcon

public void setIcon(java.awt.Image icon)

Set the icon of this top component. The icon will be used for the component's representation on the screen, e.g. in a multiwindow's tab. The default implementation just notifies the window manager.

Parameters:

icon - New components' icon.

getIcon

public java.awt.Image getIcon()

Returns:

The icon of the top component

getHelpCtx

public HelpCtx getHelpCtx()

Get the help context for this component. Subclasses should generally override this to return specific help.

Returns:

the help context

availableModes

public java.util.List availableModes(java.util.List modes)

Allows top component to specify list of modes into which can be docked by end user. Subclasses should override this method if they want to alter docking policy of top component.

So for example, by returning empty list, top component refuses to be docked anywhere.

Default implementation allows docking anywhere by returning input list unchanged.

Parameters:

modes - list of Mode which represent all modes of current workspace, can contain nulls. Items are structured in logical groups separated by null entries.

Input array also contains special constant modes for docking into newly created frames. Their names are "SingleNewMode", "MultiNewMode", "SplitNewMode", can be used for their recognition. Please note that names and existence of special modes can change in future releases.

Returns:

list of Mode which are available for dock, can contain nulls

Since:

2.14

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Serialize this top component. Subclasses wishing to store state must call the super method, then write to the stream.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - the stream to serialize to

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Deserialize this top component. Subclasses wishing to store state must call the super method, then read from the stream.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - the stream to deserialize from

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeReplace

protected java.lang.Object writeReplace()
                                 throws java.io.ObjectStreamException

Delegates instance of replacer class to be serialized instead of top component itself. Replacer class calls writeExternal and constructor, readExternal and readResolve methods properly, so 8 any top component can behave like any other externalizable object. Subclasses can override this method to perform their serialization differentrly

Throws:

java.io.ObjectStreamException

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Specified by:

getAccessibleContext in interface javax.accessibility.Accessible

Overrides:

getAccessibleContext in class java.awt.Component

getLookup

public Lookup getLookup()

Gets lookup which represents context of this component. By default the lookup delegates to result of getActivatedNodes method and result of this component ActionMap delegate.

Returns:

a lookup with designates context of this component

Since:

3.29

See Also:

org.openide.util.ContextAwareAction, org.openide.util.Utilities#actionsToPopup(Action[], Lookup)