org.netbeans.editor

Class Mark

java.lang.Object

org.netbeans.editor.Mark

Direct Known Subclasses:

MarkFactory.ContextMark, MarkFactory.SyntaxMark

Deprecated.

Use Position instead.

@Deprecated
public class Mark
extends Object

Marks hold the relative position in the document.

Constructor Summary

Constructors

Constructor and Description
Mark() Deprecated. Construct new mark with forward bias.
Mark(boolean backwardBias) Deprecated. Construct new mark.
Mark(Position.Bias bias) Deprecated.

Method Summary

Modifier and Type	Method and Description
int	compare(int pos) Deprecated. Compare this mark to some position.
void	dispose() Deprecated. Mark will no longer represent a valid place in the document.
boolean	getBackwardBias() Deprecated.
Position.Bias	getBias() Deprecated.
boolean	getInsertAfter() Deprecated.
int	getLine() Deprecated. Get the line number of this mark
int	getOffset() Deprecated. Get the position of this mark
boolean	isValid() Deprecated.
void	remove() Deprecated. Remove mark from the structure holding the marks.
protected void	removeUpdateAction(int pos, int len) Deprecated. It will not be supported in the future.
String	toString() Deprecated. Get info about Mark.

Methods inherited from class java.lang.Object

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

Constructor Detail

Mark

public Mark()

Deprecated.

Construct new mark with forward bias.

Mark

public Mark(Position.Bias bias)

Deprecated.

Mark

public Mark(boolean backwardBias)

Deprecated.

Construct new mark.

Parameters:

backwardBias - whether the inserts performed right at the position of this mark will go after this mark i.e. this mark will not move forward when inserting right at its position. This flag corresponds to Position.Bias.Backward.

Method Detail

getOffset

public final int getOffset()
                    throws InvalidMarkException

Deprecated.

Get the position of this mark

Throws:

InvalidMarkException

getLine

public final int getLine()
                  throws InvalidMarkException

Deprecated.

Get the line number of this mark

Throws:

InvalidMarkException

getInsertAfter

public final boolean getInsertAfter()

Deprecated.

Get the insertAfter flag. Replaced by Mark.getBackwardBias()

getBackwardBias

public final boolean getBackwardBias()

Deprecated.

Returns:

true if the mark has backward bias or false if it has forward bias.

getBias

public final Position.Bias getBias()

Deprecated.

Returns:

the bias of this mark. It will be either Position.Bias.Forward or Position.Bias.Backward.

dispose

public final void dispose()

Deprecated.

Mark will no longer represent a valid place in the document. Although it will not be removed from the structure that holds the marks it will be done later automatically.

remove

public final void remove()
                  throws InvalidMarkException

Deprecated.

Remove mark from the structure holding the marks. The mark can be inserted again into some document.

Throws:

InvalidMarkException

compare

public final int compare(int pos)
                  throws InvalidMarkException

Deprecated.

Compare this mark to some position.

Parameters:

pos - tested position

Returns:

zero - if the marks have the same position less than zero - if this mark is before the position greater than zero - if this mark is after the position

Throws:

InvalidMarkException

removeUpdateAction

protected void removeUpdateAction(int pos,
                                  int len)

Deprecated. It will not be supported in the future.

This function is called from removeUpdater when mark occupies the removal area. The mark can decide what to do next. If it doesn't redefine this method it will be simply moved to the begining of removal area. It is valid to add or remove other mark from this method. It is even possible (but not very useful) to add the mark to the removal area. However that mark will not be notified about current removal.

isValid

public final boolean isValid()

Deprecated.

Returns:

true if this mark is currently inserted in the document or false otherwise.

toString

public String toString()

Deprecated.

Get info about Mark.

Overrides:

toString in class Object