oracle.javatools.editor

Class BasicEditorOverview

java.lang.Object

oracle.javatools.ui.overview.Overview<java.lang.Integer,BasicEditorOverviewMark>

oracle.javatools.editor.BasicEditorOverview

All Implemented Interfaces:

Disposable

public final class BasicEditorOverview
extends Overview<java.lang.Integer,BasicEditorOverviewMark>
implements Disposable

A class that creates and manages the Overview strip that can appear to the side of a BasicEditorPane.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.ui.overview.Overview

Overview.Orientation

Field Summary

Fields inherited from class oracle.javatools.ui.overview.Overview

PROPERTY_END, PROPERTY_START, PROPERTY_STATUS

Constructor Summary

Constructors

Constructor and Description
BasicEditorOverview(BasicEditorPane editor) Create an Overview for the given editor.
BasicEditorOverview(BasicEditorPane editor, boolean isDefaultOverviewForEditor) Create an Overview for the given editor.

Method Summary

Modifier and Type	Method and Description
void	addMark(BasicEditorOverviewMark mark) Add a mark to the overview.
void	dispose() Free resources used by this object.
boolean	isShowCaretMark()
boolean	isShowEditMark()
void	rebuild() Prompt the overview to recalculate and redraw its marks.
void	removeMark(BasicEditorOverviewMark overviewMark) Remove a mark from the overview.
java.util.Collection<BasicEditorOverviewMark>	removeMarks(java.lang.Object group) Remove a group of marks from the overview.
void	setShowCaretMark(boolean showCaretMark) If set the overview will show a live mark indicating the location of the caret.
void	setShowEditMark(boolean showEditMark) If set the overview will show a live mark indicating the location of the last edit in the editor.

Methods inherited from class oracle.javatools.ui.overview.Overview

addMark, addOverviewListener, addPropertyChangeListener, getEnd, getGUI, getMarks, getStart, getStatus, removeOverviewListener, removePropertyChangeListener, setEnd, setInfoTipProvider, setStart, setStatus, setThin

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicEditorOverview

public BasicEditorOverview(BasicEditorPane editor)

Create an Overview for the given editor.

Parameters:

editor -

BasicEditorOverview

public BasicEditorOverview(BasicEditorPane editor,
                           boolean isDefaultOverviewForEditor)

Create an Overview for the given editor.

Parameters:

editor -

isDefaultOverviewForEditor - true if this is the main overview associated with an editor i.e. obtainable via EditorProperties.PROPERTY_OVERVIEW.

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Free resources used by this object.

Specified by:

dispose in interface Disposable

rebuild

public void rebuild()

Description copied from class: Overview

Prompt the overview to recalculate and redraw its marks. Normally the overview can take care of this by itself, but there may be situations where a foreced rebuild is needed.

Overrides:

rebuild in class Overview<java.lang.Integer,BasicEditorOverviewMark>

setShowEditMark

public void setShowEditMark(boolean showEditMark)

If set the overview will show a live mark indicating the location of the last edit in the editor.

Parameters:

showEditMark -

isShowEditMark

public boolean isShowEditMark()

setShowCaretMark

public void setShowCaretMark(boolean showCaretMark)

If set the overview will show a live mark indicating the location of the caret.

Parameters:

showCaretMark -

isShowCaretMark

public boolean isShowCaretMark()

removeMarks

public java.util.Collection<BasicEditorOverviewMark> removeMarks(java.lang.Object group)

Remove a group of marks from the overview. All marks in the overview that supplied the 'group' object key when being added will be removed.

Marks implementing the Disposable interface will be disposed.

Overrides:

removeMarks in class Overview<java.lang.Integer,BasicEditorOverviewMark>

Parameters:

group - the group key that identifies a group of marks

Returns:

the marks removed.

removeMark

public void removeMark(BasicEditorOverviewMark overviewMark)

Remove a mark from the overview.

Marks implementing the Disposable interface will be disposed.

Overrides:

removeMark in class Overview<java.lang.Integer,BasicEditorOverviewMark>

Parameters:

overviewMark -

addMark

public void addMark(BasicEditorOverviewMark mark)

Description copied from class: Overview

Add a mark to the overview.

Overrides:

addMark in class Overview<java.lang.Integer,BasicEditorOverviewMark>

Parameters:

mark - the mark to add