CloneableTopComponent (Window System API)

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

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, TopComponent.Cloneable
```
public abstract class CloneableTopComponent
extends TopComponent
implements java.io.Externalizable, TopComponent.Cloneable
```
A top component which may be cloned. Typically cloning is harmless, i.e. the data contents (if any) of the component are the same, and the new component is merely a different presentation. Also, a list of all cloned components is kept.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CloneableTopComponent.Ref
Keeps track of a group of sister clones.
- 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
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class org.openide.windows.TopComponent
  TopComponent.Cloneable, TopComponent.Description, TopComponent.NodeName, TopComponent.OpenActionRegistration, TopComponent.Registration, TopComponent.Registry, TopComponent.SubComponent

Nested Classes
Modifier and Type	Class	Description
`static class`	`CloneableTopComponent.Ref`	Keeps track of a group of sister clones.

Field Summary

Fields
Modifier and Type Field Description

static CloneableTopComponent.Ref EMPTY
Empty clone-sister list.
- 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
- 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 org.openide.windows.TopComponent
  CLOSE_EACH, CLOSE_LAST, PERSISTENCE_ALWAYS, PERSISTENCE_NEVER, PERSISTENCE_ONLY_OPENED, PROP_CLOSING_DISABLED, PROP_DND_COPY_DISABLED, PROP_DRAGGING_DISABLED, PROP_KEEP_PREFERRED_SIZE_WHEN_SLIDED_IN, PROP_MAXIMIZATION_DISABLED, PROP_SLIDING_DISABLED, PROP_UNDOCKING_DISABLED

Fields
Modifier and Type	Field	Description
`static CloneableTopComponent.Ref`	`EMPTY`	Empty clone-sister list.

Constructor Summary

Constructors
Constructor Description

CloneableTopComponent()
Create a cloneable top component.

Constructors
Constructor	Description
`CloneableTopComponent()`	Create a cloneable top component.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canClose()`	Unregisters this component from its clone list.
`boolean`	`canClose(Workspace workspace, boolean last)`	This method is called when top component is about to close.
`java.lang.Object`	`clone()`	Clone the top component and register the clone.
`TopComponent`	`cloneComponent()`	Clone the top component and register the clone.
`CloneableTopComponent`	`cloneTopComponent()`	Clone the top component and register the clone.
`protected boolean`	`closeLast()`	Called when the last component in a clone group is closing.
`protected void`	`componentClosed()`	Overrides superclass method, adds unregistering from references.
`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 CloneableTopComponent`	`createClonedObject()`	Called from `clone()` to actually create a new component from this one.
`CloneableTopComponent.Ref`	`getReference()`	Get a list of all components which are clone-sisters of this one.
`void`	`readExternal(java.io.ObjectInput oi)`	Deserialize this top component.
`void`	`setReference(CloneableTopComponent.Ref another)`	Changes the reference to which this components belongs.
`void`	`writeExternal(java.io.ObjectOutput oo)`	Serialize this top component.

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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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 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, getUI, 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, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, 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.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class org.openide.windows.TopComponent
addNotify, associateLookup, availableModes, cancelRequestAttention, close, close, closeNotify, componentActivated, componentDeactivated, componentHidden, componentShowing, getAccessibleContext, getActions, getActivatedNodes, getCloseOperation, getDisplayName, getHelpCtx, getHtmlDisplayName, getIcon, getLookup, getPersistenceType, getRegistry, getShortName, getSubComponents, getSystemActions, getTabPosition, getUndoRedo, isOpened, isOpened, makeBusy, open, open, openAction, openAtTabPosition, openNotify, preferredID, processKeyBinding, requestActive, requestAttention, requestFocus, requestFocusInWindow, requestVisible, setActivatedNodes, setAttentionHighlight, setCloseOperation, setDisplayName, setHtmlDisplayName, setIcon, setName, setToolTipText, toFront, writeReplace

- Field Detail
  - EMPTY
```
public static final CloneableTopComponent.Ref EMPTY
```
    Empty clone-sister list.
- Constructor Detail
  - CloneableTopComponent
```
public CloneableTopComponent()
```
    Create a cloneable top component.
- Method Detail
  - clone
```
public final java.lang.Object clone()
```
    Clone the top component and register the clone.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    the new component
  - cloneTopComponent
```
public final CloneableTopComponent cloneTopComponent()
```
    Clone the top component and register the clone. Simply calls createClonedObject () and registers the component to Ref.
    
    Returns:
    
    the new cloneable top component
  - cloneComponent
```
public final TopComponent cloneComponent()
```
    Clone the top component and register the clone.
    
    Specified by:
    
    cloneComponent in interface TopComponent.Cloneable
    
    Returns:
    
    the new component
  - createClonedObject
```
protected CloneableTopComponent createClonedObject()
```
    Called from clone() to actually create a new component from this one. The default implementation serializes and deserializes the original and returns the result. Subclasses may leave this as is, assuming they have no special needs for the cloned data besides copying it from one object to the other. If they do, the superclass method should be called, and the returned object modified appropriately.
    
    Returns:
    
    a copy of this object
  - getReference
```
public final CloneableTopComponent.Ref getReference()
```
    Get a list of all components which are clone-sisters of this one.
    
    Returns:
    
    the clone registry for this component's group
  - setReference
```
public final void setReference(CloneableTopComponent.Ref another)
```
    Changes the reference to which this components belongs.
    
    Parameters:
    
    another - the new reference this component should belong
  - componentOpened
```
protected void componentOpened()
```
    Description copied from class: TopComponent
    
    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.
    
    Overrides:
    
    componentOpened in class TopComponent
  - componentClosed
```
protected void componentClosed()
```
    Overrides superclass method, adds unregistering from references.
    
    Overrides:
    
    componentClosed in class TopComponent
    
    See Also:
    
    CloneableTopComponent.Ref
  - canClose
```
public boolean canClose()
```
    Unregisters this component from its clone list. This method is called when this TopComponent is about to close. Allows subclasses to decide if TopComponent is ready to close.
    
    Overrides:
    
    canClose in class TopComponent
  - canClose
```
public boolean canClose(Workspace workspace,
                        boolean last)
```
    Description copied from class: TopComponent
    
    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.
    
    Overrides:
    
    canClose in class TopComponent
    
    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.
  - closeLast
```
protected boolean closeLast()
```
    Called when the last component in a clone group is closing. The default implementation just returns true. Subclasses may specify some hooks to run.
    
    Returns:
    
    true if the component is ready to be closed, false to cancel
  - readExternal
```
public void readExternal(java.io.ObjectInput oi)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Description copied from class: TopComponent
    
    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
    
    Overrides:
    
    readExternal in class TopComponent
    
    Parameters:
    
    oi - the stream to deserialize from
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput oo)
                   throws java.io.IOException
```
    Description copied from class: TopComponent
    
    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
    
    Overrides:
    
    writeExternal in class TopComponent
    
    Parameters:
    
    oo - the stream to serialize to
    
    Throws:
    
    java.io.IOException

Class CloneableTopComponent

Nested Class Summary

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

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

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

Nested classes/interfaces inherited from class org.openide.windows.TopComponent

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Fields inherited from class javax.swing.JComponent

Fields inherited from class org.openide.windows.TopComponent

Constructor Summary

Method Summary

Methods inherited from class java.awt.Component

Methods inherited from class java.awt.Container

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.lang.Object

Methods inherited from class org.openide.windows.TopComponent

Field Detail

EMPTY

Constructor Detail

CloneableTopComponent

Method Detail

clone

cloneTopComponent

cloneComponent

createClonedObject

getReference

setReference

componentOpened

componentClosed

canClose

canClose

closeLast

readExternal

writeExternal