org.openide.text

Class DocumentLine

java.lang.Object

org.openide.text.Annotatable

org.openide.text.Line

org.openide.text.DocumentLine

All Implemented Interfaces:

Serializable

public abstract class DocumentLine
extends Line

Implementation of a line in a StyledDocument. One object of this class represents a line in the document by holding a PositionRef, which can represent a position in an open or closed document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentLine.Set Abstract implementation of Line.Set.

Nested classes/interfaces inherited from class org.openide.text.Line

Line.ShowOpenType, Line.ShowVisibilityType

Field Summary

Fields

Modifier and Type	Field and Description
protected PositionRef	pos reference to one position on the line

Fields inherited from class org.openide.text.Line

PROP_LINE_NUMBER, SHOW_GOTO, SHOW_REUSE, SHOW_REUSE_NEW, SHOW_SHOW, SHOW_TOFRONT, SHOW_TRY_SHOW

Fields inherited from class org.openide.text.Annotatable

PROP_ANNOTATION_COUNT, PROP_DELETED, PROP_TEXT

Constructor Summary

Constructors

Constructor and Description
DocumentLine(Lookup obj, PositionRef pos) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addAnnotation(Annotation anno) Add annotation to this Annotatable class
boolean	equals(Object o)
int	getLineNumber() Get the line number.
String	getText() Get content of the annotatable.
int	hashCode()
boolean	isBreakpoint() Deprecated.
void	markCurrentLine() Deprecated.
void	markError() Deprecated.
protected void	removeAnnotation(Annotation anno) Remove annotation to this Annotatable class
void	setBreakpoint(boolean b) Deprecated.
abstract void	show(int kind, int column) Deprecated.
void	unmarkCurrentLine() Deprecated.
void	unmarkError() Deprecated.

Methods inherited from class org.openide.text.Line

canBeMarkedCurrent, createPart, getDisplayName, getLookup, show, show, show

Methods inherited from class org.openide.text.Annotatable

addPropertyChangeListener, firePropertyChange, getAnnotationCount, isDeleted, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Detail

pos

protected PositionRef pos

reference to one position on the line

Constructor Detail

DocumentLine

public DocumentLine(Lookup obj,
                    PositionRef pos)

Constructor.

Parameters:

obj - context we belong to

pos - position on the line

Since:

4.3

Method Detail

getLineNumber

public int getLineNumber()

Description copied from class: Line

Get the line number. The last condition in following should always be true:

 
   Line.Set lineSet = <line set>
   Line l = <some line from line set lineSet>

   l.equals (lineSet.getCurrent (l.getLineNumber ()))
 

Specified by:

getLineNumber in class Line

Returns:

current line number (may change as text is edited) (starting at 0)

show

@Deprecated
public abstract void show(int kind,
                                      int column)

Deprecated.

Description copied from class: Line

Show the line.

Specified by:

show in class Line

Parameters:

kind - one of Line.SHOW_TRY_SHOW, Line.SHOW_SHOW, or Line.SHOW_GOTO

column - the column of this line which should be selected (starting at 0), value -1 does not change previously selected column

setBreakpoint

@Deprecated
public void setBreakpoint(boolean b)

Deprecated.

Description copied from class: Line

Set or clear a (debugger) breakpoint at this line.

Specified by:

setBreakpoint in class Line

Parameters:

b - true to turn on

isBreakpoint

@Deprecated
public boolean isBreakpoint()

Deprecated.

Description copied from class: Line

Test if there is a breakpoint set at this line.

Specified by:

isBreakpoint in class Line

Returns:

true is there is

markError

@Deprecated
public void markError()

Deprecated.

Description copied from class: Line

Mark an error at this line.

Specified by:

markError in class Line

unmarkError

@Deprecated
public void unmarkError()

Deprecated.

Description copied from class: Line

Unmark error at this line.

Specified by:

unmarkError in class Line

markCurrentLine

@Deprecated
public void markCurrentLine()

Deprecated.

Description copied from class: Line

Mark this line as current.

Specified by:

markCurrentLine in class Line

unmarkCurrentLine

@Deprecated
public void unmarkCurrentLine()

Deprecated.

Description copied from class: Line

Unmark this line as current.

Specified by:

unmarkCurrentLine in class Line

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

addAnnotation

protected void addAnnotation(Annotation anno)

Add annotation to this Annotatable class

Overrides:

addAnnotation in class Annotatable

Parameters:

anno - annotation which will be attached to this class

removeAnnotation

protected void removeAnnotation(Annotation anno)

Remove annotation to this Annotatable class

Overrides:

removeAnnotation in class Annotatable

Parameters:

anno - annotation which will be detached from this class

getText

public String getText()

Description copied from class: Annotatable

Get content of the annotatable. The listeners can listen on changes of PROP_TEXT property to learn that content of Annotatable is changing.

Overrides:

getText in class Line

Returns:

text representing the content of annotatable. The return value can be null, what means that document is closed.