CloneableEditor (NetBeans APIs) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:: Accessible, CloneableEditorSupport.Pane, Externalizable, HelpCtx.Provider, ImageObserver, Lookup.Provider, MenuContainer, Serializable, TopComponent.Cloneable

public class CloneableEditor
extends CloneableTopComponent
implements CloneableEditorSupport.Pane

Cloneable top component to hold the editor kit.

See Also:: Serialized Form

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

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

Returns:: one of P_X constants

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. 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 CloneableTopComponent

componentShowing

protected void componentShowing()

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

Overrides:: componentShowing in class TopComponent

createClonedObject

protected CloneableTopComponent createClonedObject()

Description copied from class: CloneableTopComponent

Called from CloneableTopComponent.clone() to actually create a new component from this one. The default implementation only clones the object by calling Object.clone(). 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.

Overrides:: createClonedObject in class CloneableTopComponent

Returns:: a copy of this object

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 TopComponent

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

See Also:: CloneableTopComponent.Ref

open

public void open(Workspace workspace)

Overrides superclass version. Opens top component only if it is in valid state. (Editor top component may become invalid after deserialization).
Also tries to open all other top components which are docked in editor mode on given workspace, but not visible.

Overrides:: open in class TopComponent

closeLast

protected boolean closeLast()

When closing last view, also close the document.

Overrides:: closeLast in class CloneableTopComponent

Returns:: true if close succeeded

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

getSystemActions

public SystemAction[] getSystemActions()

Description copied from class: TopComponent

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

Overrides:: getSystemActions in class TopComponent

Returns:: array of system actions for this component

requestFocus

public void requestFocus()

Transfer the focus to the editor pane.

Overrides:: requestFocus in class TopComponent

requestFocusInWindow

public boolean requestFocusInWindow()

Transfer the focus to the editor pane.

Overrides:: requestFocusInWindow in class TopComponent

requestDefaultFocus

public boolean requestDefaultFocus()

getPreferredSize

public Dimension getPreferredSize()

Returns:: Preferred size of editor top component

componentActivated

protected void componentActivated()

Overrides superclass method. Remembers last selected component of support belonging to this component.

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

preferredID

protected String preferredID()

Description copied from class: TopComponent

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.

Overrides:: preferredID in class TopComponent

writeExternal

public void writeExternal(ObjectOutput out)
                   throws 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 Externalizable
Overrides:: writeExternal in class CloneableTopComponent

Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         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 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()

Description copied from interface: CloneableEditorSupport.Pane

get the editor pane component represented by this wrapper.

Specified by:: getEditorPane in interface CloneableEditorSupport.Pane

ensureVisible

public void ensureVisible()

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

Specified by:: ensureVisible in interface CloneableEditorSupport.Pane

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Constructor Summary
`CloneableEditor()` For externalization of subclasses only
`CloneableEditor(CloneableEditorSupport support)` Creates new editor component associated with support object.

Method Summary
`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 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()` Called from `CloneableTopComponent.clone()` to actually create a new component from this one.
`void`	`ensureVisible()` callback for the Pane implementation to adjust itself to the openAt() request.
`CloneableTopComponent`	`getComponent()` Get the TopComponent that contains the EditorPane
`JEditorPane`	`getEditorPane()` get the editor pane component represented by this wrapper.
`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()`
`SystemAction[]`	`getSystemActions()` Gets the system actions which will appear in the popup menu of this component.
`UndoRedo`	`getUndoRedo()` The undo/redo manager of the support.
`void`	`open(Workspace workspace)` Overrides superclass version.
`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)`.
`void`	`readExternal(ObjectInput in)` Deserialize this top component.
`protected Object`	`readResolve()` Resolves deserialized object.
`boolean`	`requestDefaultFocus()`
`void`	`requestFocus()` Transfer the focus to the editor pane.
`boolean`	`requestFocusInWindow()` Transfer the focus to the editor pane.
`void`	`updateName()` Updates the name and tooltip of this `CloneableEditor` `TopCompoenent` according to the support retrieved from `cloneableEditorSupport()` method.
`void`	`writeExternal(ObjectOutput out)` Serialize this top component.
`protected Object`	`writeReplace()` Replaces serializing object.

CloneableEditor (NetBeans APIs) - NetBeans API Javadoc 4.1.0

org.openide.text Class CloneableEditor

pane

CloneableEditor

CloneableEditor

cloneableEditorSupport

getPersistenceType

getHelpCtx

canClose

componentShowing

createClonedObject

componentOpened

componentClosed

open

closeLast

getUndoRedo

getSystemActions

requestFocus

requestFocusInWindow

requestDefaultFocus

getPreferredSize

componentActivated

updateName

preferredID

writeExternal

readExternal

writeReplace

readResolve

getComponent

getEditorPane

ensureVisible

org.openide.text
Class CloneableEditor