oracle.jdevimpl.bookmarks
Class BookmarkOptions

java.lang.Object
  oracle.javatools.data.HashStructureAdapter
      oracle.jdevimpl.bookmarks.BookmarkOptions

All Implemented Interfaces:

Copyable

public final class BookmarkOptions
extends HashStructureAdapter
implements Copyable

The BookmarkOptions defines an options class that stores bookmark options.

Field Summary

static java.lang.String	KEY_SETTINGS String key to identify these options when persisted.
static int	MISSING_DISCARD The constant for indicating that bookmarks for missing lines should be discarded.
static int	MISSING_MOVE The constant for indicating that bookmarks for missing lines should be moved to the closest existing line.
static int	TRAVERSE_ALL The constant for indicating that next and previous should traverse all bookmarks.
static int	TRAVERSE_CURRENT The constant for indicating that next and previous should traverse only within the current editor.
static int	TRAVERSE_OPEN The constant for indicating that next and previous should traverse all opened editors.

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Constructor Summary

BookmarkOptions()
Construct new bookmark options.

Method Summary

boolean	getDiscardOnClose() Fetches whether to discard bookmarks when closing an editor.
boolean	getDiscardOnExit() Fetches whether to discard bookmarks when exiting JDeveloper.
static BookmarkOptions	getInstance(PropertyStorage prefs)
int	getMissingLineBehavior() Fetch the behavior of how to handle bookmarks for missing lines.
int	getTraverseBehavior() Fetch the behavior of next and previous traversal.
void	setDiscardOnClose(boolean discardOnClose) Sets whether to discard bookmarks when closing an editor.
void	setDiscardOnExit(boolean discardOnExit) Sets whether to discard bookmarks when exiting JDeveloper.
void	setMissingLineBehavior(int missingLineBehavior) Sets the new behavior of how to handle bookmarks for missing lines.
void	setTraverseBehavior(int traverseBehavior) Sets the new behavior for next and previous traversal.

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.javatools.util.Copyable

copyTo

Field Detail

KEY_SETTINGS

public static final java.lang.String KEY_SETTINGS

String key to identify these options when persisted.

See Also:

Constant Field Values

TRAVERSE_CURRENT

public static final int TRAVERSE_CURRENT

The constant for indicating that next and previous should traverse only within the current editor.

See Also:

Constant Field Values

TRAVERSE_OPEN

public static final int TRAVERSE_OPEN

The constant for indicating that next and previous should traverse all opened editors.

See Also:

Constant Field Values

TRAVERSE_ALL

public static final int TRAVERSE_ALL

The constant for indicating that next and previous should traverse all bookmarks.

See Also:

Constant Field Values

MISSING_MOVE

public static final int MISSING_MOVE

The constant for indicating that bookmarks for missing lines should be moved to the closest existing line.

See Also:

Constant Field Values

MISSING_DISCARD

public static final int MISSING_DISCARD

The constant for indicating that bookmarks for missing lines should be discarded.

See Also:

Constant Field Values

Constructor Detail

BookmarkOptions

public BookmarkOptions()

Construct new bookmark options.

Method Detail

getInstance

public static BookmarkOptions getInstance(PropertyStorage prefs)

getDiscardOnClose

public boolean getDiscardOnClose()

Fetches whether to discard bookmarks when closing an editor.

Returns:

whether to discard bookmarks when closing an editor

setDiscardOnClose

public void setDiscardOnClose(boolean discardOnClose)

Sets whether to discard bookmarks when closing an editor.

Parameters:

discardOnClose - sets whether to discard bookmarks when closing an editor

getDiscardOnExit

public boolean getDiscardOnExit()

Fetches whether to discard bookmarks when exiting JDeveloper.

Returns:

whether to discard bookmarks when exiting JDeveloper.

setDiscardOnExit

public void setDiscardOnExit(boolean discardOnExit)

Sets whether to discard bookmarks when exiting JDeveloper.

Parameters:

discardOnExit - sets whether to discard bookmarks when exiting JDeveloper.

getTraverseBehavior

public int getTraverseBehavior()

Fetch the behavior of next and previous traversal.

Returns:

the behavior of next and previous traversal

setTraverseBehavior

public void setTraverseBehavior(int traverseBehavior)

Sets the new behavior for next and previous traversal.

Parameters:

traverseBehavior - the new behavior for next and previous traversal

getMissingLineBehavior

public int getMissingLineBehavior()

Fetch the behavior of how to handle bookmarks for missing lines.

Returns:

the behavior of how to handle bookmarks for missing lines

setMissingLineBehavior

public void setMissingLineBehavior(int missingLineBehavior)

Sets the new behavior of how to handle bookmarks for missing lines.

Parameters:

missingLineBehavior - the new behavior of how to handle bookmarks for missing lines.