|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ide.navigation.DefaultNavigationPoint oracle.ide.ceditor.CodeNavigationPoint
public class CodeNavigationPoint
CodeNavigationPoint is a NavigationPoint implementation intended for registration with the NavigationManager as an EditorNavigationPoint for the CodeEditor class. It is also useful for subclassing by standard NavigationPoint implementations which act upon a FindableEditor.
Field Summary | |
---|---|
protected int |
change
Change index into TextBufferTracker at time of setting Context |
protected boolean |
explicit
Flag indicating that the newly opened Editor should be opened as explicit. |
protected java.lang.Class |
preferredType
Preferred Editor type when opening a new Editor. |
protected int |
selLength
Length of selection hilight beginning at #start |
protected int |
start
Starting offset to be navigated to. |
protected TextBufferTracker |
tracker
TextBufferTracker monitoring changes to #start and #selLength values |
Fields inherited from class oracle.ide.navigation.DefaultNavigationPoint |
---|
done, nodeURL, prjURL, viewClass, viewID, wspURL |
Fields inherited from interface oracle.ide.navigation.NavigationPoint |
---|
CANCEL, OK |
Constructor Summary | |
---|---|
|
CodeNavigationPoint()
Default constructor. |
protected |
CodeNavigationPoint(Context context,
int start,
int length)
Constructor. |
Method Summary | |
---|---|
java.lang.Object |
copyTo(java.lang.Object target)
Copies the internal state of this object to the specified target. |
protected void |
copyToImpl(CodeNavigationPoint point)
Copy the pertinent state information. |
boolean |
equals(java.lang.Object o)
|
protected Editor |
findOrCreateEditor(boolean activate)
Find the existing Editor opened on our Context, else attempt to open a new Editor instance. |
java.lang.String |
getLongLabel()
Returns a long label that can be displayed to the user. |
java.lang.Class |
getPreferredEditorType()
Get the preferred Editor type to use when asking the EditorManager to open our Context in an Editor. |
protected static void |
gotoOffset(BasicEditorPaneContainer editor,
int offset,
int range)
Reposition the cursor to the given offset, hilighting as necessary. |
void |
refresh()
Fetch and remember the current caret position of the focused editor pane of the FindableEditor. |
protected int |
renavigate()
Reset focus to existing open Editor, else open new Editor instance if no longer available, and set the cursor at the last location remembered from our #refresh method. |
void |
setContext(Context context)
|
void |
setExplicit(boolean explicit)
Set the explicit flag. |
void |
setPreferredEditorType(java.lang.Class cls)
Set the preferred Editor type to use when asking the EditorManager to open the Context in an Editor. |
Methods inherited from class oracle.ide.navigation.DefaultNavigationPoint |
---|
addNavigationPointListener, contextRemoved, copyToImpl, findEditorInfo, fireDescriptionChanged, fireExpired, getContext, getIcon, getShortLabel, getToolTipText, navigate, navigateImpl, nodeRenamed, projectRenamed, removeNavigationPointListener, toString, workspaceRenamed |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected int start
protected int selLength
protected int change
protected TextBufferTracker tracker
protected java.lang.Class preferredType
protected boolean explicit
Constructor Detail |
---|
public CodeNavigationPoint()
protected CodeNavigationPoint(Context context, int start, int length)
context
- the Context describing the Editor in which to navigate.start
- the offset to navigate to, negative value indicates that
opening the Editor is enough with no further navigation needed.length
- number of characters to hilight beginning at start.Method Detail |
---|
public void setContext(Context context)
setContext
in interface oracle.ide.navigation.EditorNavigationPoint
setContext
in class oracle.ide.navigation.DefaultNavigationPoint
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public java.lang.Object copyTo(java.lang.Object target)
copyTo
in interface Copyable
copyTo
in class oracle.ide.navigation.DefaultNavigationPoint
target
- the Object to receive the state, or null.
Copyable
protected final void copyToImpl(CodeNavigationPoint point)
point
- the NavigationPoint whose state is to be altered.public void refresh()
refresh
in interface oracle.ide.navigation.NavigationPoint
refresh
in class oracle.ide.navigation.DefaultNavigationPoint
public void setExplicit(boolean explicit)
explicit
- true if the Editor should be opened as explicit.explicit
protected int renavigate() throws java.lang.Exception
renavigate
in class oracle.ide.navigation.DefaultNavigationPoint
java.lang.Exception
- on failure.public java.lang.Class getPreferredEditorType()
EditorManager#openEditorInFrame( Context )
public void setPreferredEditorType(java.lang.Class cls)
cls
- the preferred Editor type, else null to use the default Editor.EditorManager#openEditorInFrame( Context )
protected Editor findOrCreateEditor(boolean activate)
activate
- true if a the Editor should also be activated.
protected static void gotoOffset(BasicEditorPaneContainer editor, int offset, int range)
editor
- the FindableEditor in which the cursor is to be relocated.offset
- the offset to relocate to.range
- the length from offset which should be hilighted.public java.lang.String getLongLabel()
Displayable
String
is considered translatable
and should therefore be placed in an appropriate resource file.
The long label differs from the short label essentially on length.
Usually the long label will only be shown on-demand and in places
where horizontal space is more available. Examples are the status
bar and tooltips.
getLongLabel
in interface Displayable
getLongLabel
in class oracle.ide.navigation.DefaultNavigationPoint
Displayable
that
can be shown to the user.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |