Overview (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

java.lang.Object
- oracle.javatools.ui.overview.Overview<T,M>

Type Parameters:

T - The type of the scale used by the overview (e.g. Float, Integer).

M - The type of OverviewMark that can be added to the Overview

Direct Known Subclasses:

BasicEditorOverview
```
public class Overview<T extends java.lang.Number,M extends OverviewMark<T>>
extends java.lang.Object
```
A class to create and manage an Overview component. An Overview component is a strip down the edge of an editor, or other partially visible component, and containing marks to indicate points of interest over the whole component. e.g. Errors in a source code editor.
The overview has an arbitrary start and end; and marks are placed at locations along this scale. Marks are rendered in a linear scale along the overview.
Marks have a priority, and when marks overlap: marks with lower priorities appear below marks with higher priorities.
Marks can be placed into groups which can all be removed at once.
The overview can optionally display a status indicator to display information about the overview: e.g. "Compiling", "4 Errors, 3 Warnings".
The class is not a component itself, the overview UI component can be obtained via Overview.getGUI() and added to a component hierarchy.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Overview.Orientation
The direction of the Overview.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Overview.Orientation` The direction of the Overview.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROPERTY_END` Property fired when the end of the overview changes.
`static java.lang.String`	`PROPERTY_START` Property fired when the start of the overview changes.
`static java.lang.String`	`PROPERTY_STATUS` Property fired when the overview status changes.

Constructor Summary

Constructors
Constructor and Description
`Overview(Overview.Orientation orientation, T start, T end)` Construct an Overview with the given orientation.
`Overview(T start, T end)` Construct an Overview with a vertical orientation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMark(M mark)` Add a mark to the overview.
`void`	`addMark(M mark, java.lang.Object group)` Add a mark to the overview.
`void`	`addOverviewListener(OverviewListener<M> listener)` Listen for changes in the overview.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)`
`T`	`getEnd()` The overview can be of an arbitrary size.
`javax.swing.JComponent`	`getGUI()`
`protected java.util.Collection<M>`	`getMarks()`
`T`	`getStart()` The overview can start at an abitrary point.
`OverviewStatus`	`getStatus()`
`void`	`rebuild()` Prompt the overview to recalculate and redraw its marks.
`void`	`removeMark(M mark)` Remove a mark from the overview.
`java.util.Collection<M>`	`removeMarks(java.lang.Object group)` Remove all marks that are part of the given group.
`void`	`removeOverviewListener(OverviewListener<M> listener)` Stop listener to changes in the overview.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)`
`void`	`setEnd(T end)` Set the end point of the overview.
`void`	`setInfoTipProvider(OverviewTipProvider overviewInfoTipProvider)`
`void`	`setStart(T start)` Set the start of the overview.
`void`	`setStatus(OverviewStatus status)` Set the overviews overall status indicator (can be null for no overall status indicator).
`void`	`setThin(boolean thin)` Make the overview GUI thinner than usual.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROPERTY_END
```
public static final java.lang.String PROPERTY_END
```
    Property fired when the end of the overview changes.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_START
```
public static final java.lang.String PROPERTY_START
```
    Property fired when the start of the overview changes.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_STATUS
```
public static final java.lang.String PROPERTY_STATUS
```
    Property fired when the overview status changes.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Overview
```
public Overview(T start,
                T end)
```
    Construct an Overview with a vertical orientation.
    
    Parameters:
    
    start -
    
    end -
  - Overview
```
public Overview(Overview.Orientation orientation,
                T start,
                T end)
```
    Construct an Overview with the given orientation.
    
    Parameters:
    
    orientation -
    
    start -
    
    end -
- Method Detail
  - getGUI
```
public javax.swing.JComponent getGUI()
```
    Returns:
    
    the JComponent to add to a UI which displays the overview.
  - setThin
```
public void setThin(boolean thin)
```
    Make the overview GUI thinner than usual.
    
    Parameters:
    
    thin -
  - rebuild
```
public void rebuild()
```
    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.
  - addMark
```
public void addMark(M mark)
```
    Add a mark to the overview.
    
    Parameters:
    
    mark - the mark to add
  - addMark
```
public void addMark(M mark,
                    java.lang.Object group)
```
    Add a mark to the overview. The mark is added to the group indicated by the given key.
    All marks in a group can be removed in one go via a call to removeMarks(Object).
    
    Parameters:
    
    mark - the mark to add
    
    group - a unique key for the group the mark belongs to.
  - removeMark
```
public void removeMark(M mark)
```
    Remove a mark from the overview.
    
    Parameters:
    
    mark -
  - removeMarks
```
public java.util.Collection<M> removeMarks(java.lang.Object group)
```
    Remove all marks that are part of the given group.
    
    Parameters:
    
    group -
    
    Returns:
    
    the marks which were removed
  - getStart
```
public T getStart()
```
    The overview can start at an abitrary point. Marks are placed lineally along the overview between start and end.
    
    Returns:
    
    the start of the overview
  - setStart
```
public void setStart(T start)
```
    Set the start of the overview. All marks must be contained between start and end.
    
    Parameters:
    
    start -
  - getEnd
```
public T getEnd()
```
    The overview can be of an arbitrary size. Marks are placed linearally along the overview between the start and end points.
    
    Returns:
    
    the end of the overview
  - setEnd
```
public void setEnd(T end)
```
    Set the end point of the overview. All marks must be contained between start and end.
    
    Parameters:
    
    end -
  - getMarks
```
protected final java.util.Collection<M> getMarks()
```
    Returns:
    
    a collection of all marks
  - addOverviewListener
```
public void addOverviewListener(OverviewListener<M> listener)
```
    Listen for changes in the overview.
    
    Parameters:
    
    listener -
  - removeOverviewListener
```
public void removeOverviewListener(OverviewListener<M> listener)
```
    Stop listener to changes in the overview.
    
    Parameters:
    
    listener -
  - setStatus
```
public void setStatus(OverviewStatus status)
```
    Set the overviews overall status indicator (can be null for no overall status indicator).
    
    Parameters:
    
    status -
  - getStatus
```
public OverviewStatus getStatus()
```
    Returns:
    
    the overall Status (or null if no overall status).
  - setInfoTipProvider
```
public void setInfoTipProvider(OverviewTipProvider overviewInfoTipProvider)
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Parameters:
    
    listener -
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Parameters:
    
    listener -

Class Overview<T extends java.lang.Number,M extends OverviewMark<T>>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_END

PROPERTY_START

PROPERTY_STATUS

Constructor Detail

Overview

Overview

Method Detail

getGUI

setThin

rebuild

addMark

addMark

removeMark

removeMarks

getStart

setStart

getEnd

setEnd

getMarks

addOverviewListener

removeOverviewListener

setStatus

getStatus

setInfoTipProvider

addPropertyChangeListener

removePropertyChangeListener