TopComponent (NetBeans Windows API) - NetBeans API Javadoc 5.0.0

org.openide.windows
Class TopComponent

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              org.openide.windows.TopComponent

All Implemented Interfaces:

Accessible, Externalizable, HelpCtx.Provider, ImageObserver, Lookup.Provider, MenuContainer, Serializable

Direct Known Subclasses:

CloneableTopComponent

public class TopComponent

extends JComponent

implements Externalizable, Accessible, HelpCtx.Provider, Lookup.Provider

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.

See Also:

Serialized Form

Nested Class Summary
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           Deprecated. Please do not use. This support class does nothing much useful. If you need to synchronize display name of your TopComponent with some Node's display name, we recommend you to do it manually in your client's code.
static interface	TopComponent.Registry           Registry of all top components.

 

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

 

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

 

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

 

Field Summary
static int	CLOSE_EACH           Deprecated. Do not use. It is redundant since workspaces are not supported anymore.
static int	CLOSE_LAST           Deprecated. Do not use. It is redundant since workspaces are not supported anymore.
static int	PERSISTENCE_ALWAYS           Persistence type of TopComponent instance.
static int	PERSISTENCE_NEVER           Persistence type of TopComponent instance.
static int	PERSISTENCE_ONLY_OPENED           Persistence type of TopComponent instance.

 

Fields inherited from class javax.swing.JComponent

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

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

TopComponent()           Create a top component.

TopComponent(Lookup lookup)           Creates a top component for a provided lookup that will delegate take and synchronize activated nodes and ActionMap from a provided lookup.

 

Method Summary
protected  void	associateLookup(Lookup lookup)           Associates the provided lookup with the component.
List	availableModes(List modes)           Allows top component to specify list of modes into which can be docked by end user.
void	cancelRequestAttention()           Cause this TopComponent's tab to stop flashing if it was flashing.
boolean	canClose()           This method is called when this TopComponent is about to close.
boolean	canClose(Workspace workspace, boolean last)           Deprecated. Do not use anymore. Use canClose() instead. Both parameters are redundant since workspaces are not supported anymore.
boolean	close()           Closes this TopComponent.
boolean	close(Workspace workspace)           Deprecated. Use close() instead.
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.
AccessibleContext	getAccessibleContext()
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()           Deprecated. Do not use. It is redundant since workspaces are not supported anymore.
String	getDisplayName()           Gets localized display name of this TopComponent.
HelpCtx	getHelpCtx()           Get the help context for this component.
String	getHtmlDisplayName()           Gets localized display name of this TopComponent with added html tags for text coloring and/or font style.
Image	getIcon()
Lookup	getLookup()           Gets lookup which represents context of this component.
int	getPersistenceType()           Overwrite when you want to change default persistence type.
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()           Indicates whether this TopComponent is opened.
boolean	isOpened(Workspace workspace)           Deprecated. Use isOpened() instead.
void	open()           Shows this TopComponent.
void	open(Workspace workspace)           Deprecated. Use open() instead.
protected  void	openNotify()           Deprecated. Use componentOpened() instead.
protected  String	preferredID()           Subclasses are encouraged to override this method to provide preferred value for unique TopComponent ID returned by WindowManager.findTopComponentID(org.openide.windows.TopComponent).
protected  boolean	processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)           Overrides superclass method, adds possible additional handling of global keystrokes in case this TopComoponent is ancestor of focused component.
void	readExternal(ObjectInput in)           Deserialize this top component.
void	requestActive()           Activates this TopComponent if it is opened.
void	requestAttention(boolean brief)           Cause this TopComponent's tab to flash or otherwise draw attention to itself.
void	requestFocus()           Deprecated. Use requestActive() instead to make TopComponent active in window system not only focused. This method should have been preserved for focus management only but not activation of TopComponent inside window system. The default implementation does nothing, and does not call super.requestFocus().
boolean	requestFocusInWindow()           Deprecated. Use requestActive() instead to make TopComponent active in window system not only focused. This method should have been preserved for focus management only but not activation of TopComponent inside window system. The default implementation does nothing, and does not call super.requestFocusInWindow().
void	requestVisible()           Selects this TopComponent, if it is opened, but does not activate it unless it is in active mode already.
void	setActivatedNodes(Node[] activatedNodes)           Set the set of activated nodes in this component.
void	setCloseOperation(int closeOperation)           Deprecated. Do not use. It is redundant since workspaces are not supported anymore.
void	setDisplayName(String displayName)           Sets localized display name of this TopComponent.
void	setHtmlDisplayName(String htmlDisplayName)           Sets localized html display name of this TopComponent.
void	setIcon(Image icon)           Set the icon of this top component.
void	setName(String name)           Set the name of this top component.
void	setToolTipText(String toolTip)           Sets toolTip for this TopComponent, adds notification about the change to its WindowManager.TopComponentManager.
void	toFront()           Attempts to bring the parent Window or Frame of this TopComponent to front of other windows.
void	writeExternal(ObjectOutput out)           Serialize this top component.
protected  Object	writeReplace()           Delegates instance of replacer class to be serialized instead of top component itself.

 

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus, 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

Deprecated. Do not use. It is redundant since workspaces are not supported anymore.

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

See Also:

Constant Field Values

CLOSE_LAST

public static final int CLOSE_LAST

Deprecated. Do not use. It is redundant since workspaces are not supported anymore.

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

PERSISTENCE_ALWAYS

public static final int PERSISTENCE_ALWAYS

Persistence type of TopComponent instance. TopComponent is persistent.

See Also:

Constant Field Values

PERSISTENCE_ONLY_OPENED

public static final int PERSISTENCE_ONLY_OPENED

Persistence type of TopComponent instance. TopComponent is persistent only when it is opened in Mode.

See Also:

Constant Field Values

PERSISTENCE_NEVER

public static final int PERSISTENCE_NEVER

Persistence type of TopComponent instance. TopComponent is not persistent.

See Also:

Constant Field Values

TopComponent

public TopComponent()

Create a top component.

TopComponent

public TopComponent(Lookup lookup)

Creates a top component for a provided lookup that will delegate take and synchronize activated nodes and ActionMap from a provided lookup. The lookup will also be returned from getLookup() method, if not overriden.

Parameters:

lookup - the lookup to associate with

Since:

4.19

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 or null, null means such component does not change TopComponent.Registry.getActivatedNodes() just TopComponent.Registry.getCurrentNodes() when this component gets activated

setActivatedNodes

public final void setActivatedNodes(Node[] activatedNodes)

Set the set of activated nodes in this component.

Parameters:

activatedNodes - activated nodes for this component

getPersistenceType

public int getPersistenceType()

Overwrite when you want to change default persistence type. Default persistence type is PERSISTENCE_ALWAYS. Return value should be constant over a given TC's lifetime.

Returns:

one of P_X constants

Since:

4.20

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()

Shows this TopComponent. Note: This method only makes it visible, but does not activates it.

See Also:

requestActive()

open

public void open(Workspace workspace)

Deprecated. Use open() instead.

Shows this TopComponent in current workspace. Node: Currently workspaces are not supported. The method has the same effect like open().

isOpened

public final boolean isOpened()

Indicates whether this TopComponent is opened.

Returns:

true if given top component is opened, false otherwise

isOpened

public final boolean isOpened(Workspace workspace)

Deprecated. Use isOpened() instead.

Indicates whether this TopComponent is opened in current workspace. Node: Currently workspaces are not supported. The method has the same effect like isOpened().

close

public final boolean close()

Closes this TopComponent.

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)

Deprecated. Use close() instead.

Closes this TopComponent in current workspace. Node: Currently workspaces are not supported. The method has the same effect like close().

canClose

public boolean canClose()

This method is called when this TopComponent is about to close. Allows subclasses to decide if TopComponent is ready to close.

Since:

4.13

canClose

public boolean canClose(Workspace workspace,
                        boolean last)

Deprecated. Do not use anymore. Use canClose() instead. Both parameters are redundant since workspaces are not supported anymore.

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 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)

Deprecated. Do not use. It is redundant since workspaces are not supported anymore.

Set the close mode for the component.

Parameters:

closeOperation - one of CLOSE_EACH or CLOSE_LAST

Throws:

IllegalArgumentException - if an unrecognized close mode was supplied

See Also:

close()

getCloseOperation

public final int getCloseOperation()

Deprecated. Do not use. It is redundant since workspaces are not supported anymore.

Get the current close mode for this component.

Returns:

one of CLOSE_EACH or CLOSE_LAST

preferredID

protected String preferredID()

Subclasses are encouraged to override this method to provide preferred value for unique TopComponent ID returned by WindowManager.findTopComponentID(org.openide.windows.TopComponent). Returned value should be a String, preferably describing semantics of TopComponent subclass, such as "PieChartViewer" or "HtmlEditor" etc. Value is then used by window system as prefix value for creating unique TopComponent ID. Returned String value should be preferably unique, but need not be.

Since:

4.13

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()

Deprecated. Use requestActive() instead to make TopComponent active in window system not only focused. This method should have been preserved for focus management only but not activation of TopComponent inside window system. The default implementation does nothing, and does not call super.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 CloneableEditor.

requestFocusInWindow

public boolean requestFocusInWindow()

Deprecated. Use requestActive() instead to make TopComponent active in window system not only focused. This method should have been preserved for focus management only but not activation of TopComponent inside window system. The default implementation does nothing, and does not call super.requestFocusInWindow().

Request focus for the top component inside focused window. 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 CloneableEditor.

requestActive

public void requestActive()

Activates this TopComponent if it is opened.

Since:

4.13

public void toFront()

public void requestVisible()

public final void requestAttention(boolean brief)

public final void cancelRequestAttention()

public void setName(String name)

public void setDisplayName(String displayName)

public String getDisplayName()

public void setHtmlDisplayName(String htmlDisplayName)

public String getHtmlDisplayName()

public void setToolTipText(String toolTip)

public void setIcon(Image icon)

public Image getIcon()

public HelpCtx getHelpCtx()

public List availableModes(List modes)

protected boolean processKeyBinding(KeyStroke ks,
                                    KeyEvent e,
                                    int condition,
                                    boolean pressed)

public void writeExternal(ObjectOutput out)
                   throws IOException

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

protected Object writeReplace()
                       throws ObjectStreamException

public AccessibleContext getAccessibleContext()

public Lookup getLookup()

protected final void associateLookup(Lookup lookup)