org.openide.text

Class CloneableEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.openide.windows.TopComponent

org.openide.windows.CloneableTopComponent

org.openide.text.CloneableEditor

All Implemented Interfaces:

ImageObserver, MenuContainer, Externalizable, Serializable, Accessible, CloneableEditorSupport.Pane, HelpCtx.Provider, Lookup.Provider, TopComponent.Cloneable

public class CloneableEditor
extends CloneableTopComponent
implements CloneableEditorSupport.Pane

Cloneable top component to hold the editor kit.

See Also:

Serialized Form

Nested Class Summary

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

CloneableTopComponent.Ref

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

Modifier and Type	Field and Description
protected JEditorPane	pane editor pane

Fields inherited from class org.openide.windows.CloneableTopComponent

EMPTY

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 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
CloneableEditor() For externalization of subclasses only
CloneableEditor(CloneableEditorSupport support) Creates new editor component associated with support object.
CloneableEditor(CloneableEditorSupport support, boolean associateLookup) Creates new editor component associated with support object (possibly also with its lookup.

Method Summary

Modifier and Type	Method and Description
boolean	canClose() Indicates whether this component can be closed.
protected CloneableEditorSupport	cloneableEditorSupport() Gives access to CloneableEditorSupport object under this CloneableEditor component.
protected boolean	closeLast() When closing last view, also close the document.
protected boolean	closeLast(boolean ask) Utility method to close the document.
protected void	componentActivated() Overrides superclass method.
protected void	componentClosed() Descendants overriding this method must either call this implementation or fire the EditorCookie.Observable.PROP_OPENED_PANES property change on their own.
protected void	componentOpened() Descendants overriding this method must either call this implementation or fire the EditorCookie.Observable.PROP_OPENED_PANES property change on their own.
protected void	componentShowing() Overrides superclass method.
protected CloneableTopComponent	createClonedObject()
void	ensureVisible() callback for the Pane implementation to adjust itself to the openAt() request.
Action[]	getActions()
CloneableTopComponent	getComponent() Get the TopComponent that contains the EditorPane
JEditorPane	getEditorPane() Returns editor pane.
HelpCtx	getHelpCtx() Get context help for this editor pane.
int	getPersistenceType() Overriden to explicitely set persistence type of CloneableEditor to PERSISTENCE_ONLY_OPENED
Dimension	getPreferredSize()
UndoRedo	getUndoRedo() The undo/redo manager of the support.
protected void	initializeBySupport() Asks the associated CloneableEditorSupport to initialize this editor via its CloneableEditorSupport.initializeCloneableEditor(org.openide.text.CloneableEditor) method.
void	open()
protected String	preferredID()
void	readExternal(ObjectInput in)
protected Object	readResolve() Resolves deserialized object.
boolean	requestDefaultFocus() Deprecated.
void	requestFocus() Deprecated.
boolean	requestFocusInWindow() Deprecated.
void	updateName() Updates the name and tooltip of this CloneableEditor TopCompoenent according to the support retrieved from CloneableEditor.cloneableEditorSupport() method.
void	writeExternal(ObjectOutput out)
protected Object	writeReplace() Replaces serializing object.

Methods inherited from class org.openide.windows.CloneableTopComponent

canClose, clone, cloneComponent, cloneTopComponent, getReference, setReference

Methods inherited from class org.openide.windows.TopComponent

addNotify, associateLookup, availableModes, cancelRequestAttention, close, close, closeNotify, componentDeactivated, componentHidden, getAccessibleContext, getActivatedNodes, getCloseOperation, getDisplayName, getHtmlDisplayName, getIcon, getLookup, getRegistry, getShortName, getSubComponents, getSystemActions, getTabPosition, isOpened, isOpened, makeBusy, open, openAction, openAtTabPosition, openNotify, processKeyBinding, requestActive, requestAttention, requestVisible, setActivatedNodes, setAttentionHighlight, setCloseOperation, setDisplayName, setHtmlDisplayName, setIcon, setName, setToolTipText, toFront

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, 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, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, 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.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

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

pane

protected JEditorPane pane

editor pane

Constructor Detail

CloneableEditor

public CloneableEditor()

For externalization of subclasses only

CloneableEditor

public CloneableEditor(CloneableEditorSupport support)

Creates new editor component associated with support object.

Parameters:

support - support that holds the document and operations above it

CloneableEditor

public CloneableEditor(CloneableEditorSupport support,
                       boolean associateLookup)

Creates new editor component associated with support object (possibly also with its lookup.

Parameters:

support - support that holds the document and operations above it

associateLookup - true, if TopComponent.getLookup() should return the lookup associated with CloneableEditorSupport.

Method Detail

cloneableEditorSupport

protected CloneableEditorSupport cloneableEditorSupport()

Gives access to CloneableEditorSupport object under this CloneableEditor component.

Returns:

the CloneableEditorSupport object that holds the document or null, what means this component is not in valid state yet and can be discarded

getPersistenceType

public int getPersistenceType()

Overriden to explicitely set persistence type of CloneableEditor to PERSISTENCE_ONLY_OPENED

Overrides:

getPersistenceType in class TopComponent

getHelpCtx

public HelpCtx getHelpCtx()

Get context help for this editor pane. If the registered editor kit provides a help ID in bean info according to the protocol described for HelpCtx.findHelp(java.awt.Component), then that it used, else general help on the editor is provided.

Specified by:

getHelpCtx in interface HelpCtx.Provider

Overrides:

getHelpCtx in class TopComponent

Returns:

context help

canClose

public boolean canClose()

Indicates whether this component can be closed. Adds scheduling of "emptying" editor pane and removing all sub components.

Overrides:

canClose in class CloneableTopComponent

componentShowing

protected void componentShowing()

Overrides superclass method. In case it is called first time, initializes this CloneableEditor.

Overrides:

componentShowing in class TopComponent

initializeBySupport

protected final void initializeBySupport()

Asks the associated CloneableEditorSupport to initialize this editor via its CloneableEditorSupport.initializeCloneableEditor(org.openide.text.CloneableEditor) method. By default called from the support on various occasions including shortly after creation and after the CloneableEditor has been deserialized.

Since:

6.37

createClonedObject

protected CloneableTopComponent createClonedObject()

Overrides:

createClonedObject in class CloneableTopComponent

componentOpened

protected void componentOpened()

Descendants overriding this method must either call this implementation or fire the EditorCookie.Observable.PROP_OPENED_PANES property change on their own.

Overrides:

componentOpened in class CloneableTopComponent

componentClosed

protected void componentClosed()

Descendants overriding this method must either call this implementation or fire the EditorCookie.Observable.PROP_OPENED_PANES property change on their own.

Overrides:

componentClosed in class CloneableTopComponent

closeLast

protected boolean closeLast()

When closing last view, also close the document. Calls closeLast(true).

Overrides:

closeLast in class CloneableTopComponent

Returns:

true if close succeeded

closeLast

protected final boolean closeLast(boolean ask)

Utility method to close the document.

Parameters:

ask - verify and ask the user whether a document can be closed or not?

Returns:

true if the document was successfully closed

Since:

6.37

getUndoRedo

public UndoRedo getUndoRedo()

The undo/redo manager of the support.

Overrides:

getUndoRedo in class TopComponent

Returns:

the undo/redo manager shared by all editors for this support

getActions

public Action[] getActions()

Overrides:

getActions in class TopComponent

requestFocus

@Deprecated
public void requestFocus()

Deprecated.

Transfer the focus to the editor pane.

Overrides:

requestFocus in class TopComponent

requestFocusInWindow

@Deprecated
public boolean requestFocusInWindow()

Deprecated.

Transfer the focus to the editor pane.

Overrides:

requestFocusInWindow in class TopComponent

requestDefaultFocus

@Deprecated
public boolean requestDefaultFocus()

Deprecated.

Overrides:

requestDefaultFocus in class JComponent

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

Returns:

Preferred size of editor top component

open

public void open()

Overrides:

open in class TopComponent

componentActivated

protected void componentActivated()

Overrides superclass method. Remembers last selected component of support belonging to this component. Descendants overriding this method must call this implementation to set last selected pane otherwise CloneableEditorSupport.getRecentPane and CloneableEditorSupport.getOpenedPanes will be broken.

Overrides:

componentActivated in class TopComponent

See Also:

TopComponent.componentDeactivated()

updateName

public void updateName()

Updates the name and tooltip of this CloneableEditor TopCompoenent according to the support retrieved from CloneableEditor.cloneableEditorSupport() method. The name and tooltip are in case of support presence updated thru its CloneableEditorSupport.messageName() and CloneableEditorSupport.messageToolTip() methods.

Specified by:

updateName in interface CloneableEditorSupport.Pane

See Also:

CloneableEditor.cloneableEditorSupport()

preferredID

protected String preferredID()

Overrides:

preferredID in class TopComponent

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class CloneableTopComponent

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class CloneableTopComponent

Throws:

IOException

ClassNotFoundException

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Replaces serializing object. Overrides superclass method. Adds checking for object validity. In case this object is invalid throws NotSerializableException.

Overrides:

writeReplace in class TopComponent

Throws:

ObjectStreamException - When problem during serialization occures.

NotSerializableException - When this CloneableEditor is invalid and doesn't want to be serialized.

readResolve

protected Object readResolve()
                      throws ObjectStreamException

Resolves deserialized object. Overrides superclass method. Adds checking for object validity. In case this object is invalid throws InvalidObjectException.

Throws:

ObjecStreamException - When problem during serialization occures.

InvalidObjectException - When deserialized CloneableEditor is invalid and shouldn't be used.

ObjectStreamException

getComponent

public CloneableTopComponent getComponent()

Description copied from interface: CloneableEditorSupport.Pane

Get the TopComponent that contains the EditorPane

Specified by:

getComponent in interface CloneableEditorSupport.Pane

getEditorPane

public JEditorPane getEditorPane()

Returns editor pane. Returns null if document loading was canceled by user through answering UserQuestionException or when CloneableEditor is closed.

Specified by:

getEditorPane in interface CloneableEditorSupport.Pane

Returns:

editor pane or null

ensureVisible

public void ensureVisible()

callback for the Pane implementation to adjust itself to the openAt() request.

Specified by:

ensureVisible in interface CloneableEditorSupport.Pane