JabRef 5.15 · org.jabref.model.openoffice.DocumentAnnotation

Field Summary

Modifier and Type	Field and Description
private final boolean	absorb Record Component accessed by absorb(). ReferenceMark, Bookmark and TextSection can incorporate a text range.
private final com.sun.star.text.XTextDocument	doc Record Component accessed by doc(). The document
private final String	name Record Component accessed by name(). For the ReferenceMark, Bookmark, TextSection.
private final com.sun.star.text.XTextRange	range Record Component accessed by range(). Cursor marking the location or range for the thing to be inserted.

Constructor Summary

Access	Constructor and Description
public	DocumentAnnotation(com.sun.star.text.XTextDocument doc, String name, com.sun.star.text.XTextRange range, boolean absorb)

Method Summary

Modifier and Type	Method and Description
public boolean	absorb() Record Component getter of absorb. Record Component ReferenceMark, Bookmark and TextSection can incorporate a text range.
public com.sun.star.text.XTextDocument	doc() Record Component getter of doc. Record Component The document
public final boolean	equals(Object the reference object with which to compare. o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public String	name() Record Component getter of name. Record Component For the ReferenceMark, Bookmark, TextSection.
public com.sun.star.text.XTextRange	range() Record Component getter of range. Record Component Cursor marking the location or range for the thing to be inserted.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

absorb	back to summary
private final boolean absorb Record Component accessed by absorb(). ReferenceMark, Bookmark and TextSection can incorporate a text range. If absorb is true, the text in the range becomes part of the thing. If absorb is false, the thing is inserted at the end of the range.

absorb

back to summary

private final boolean absorb

Record Component accessed by absorb().

ReferenceMark, Bookmark and TextSection can incorporate a text range. If absorb is true, the text in the range becomes part of the thing. If absorb is false, the thing is inserted at the end of the range.

doc	back to summary
private final com.sun.star.text.XTextDocument doc Record Component accessed by doc(). The document

doc

back to summary

private final com.sun.star.text.XTextDocument doc

Record Component accessed by doc().

The document

name	back to summary
private final String name Record Component accessed by name(). For the ReferenceMark, Bookmark, TextSection. If the name is already in use, LibreOffice may change the name.

name

back to summary

private final String name

Record Component accessed by name().

For the ReferenceMark, Bookmark, TextSection. If the name is already in use, LibreOffice may change the name.

range	back to summary
private final com.sun.star.text.XTextRange range Record Component accessed by range(). Cursor marking the location or range for the thing to be inserted.

range

back to summary

private final com.sun.star.text.XTextRange range

Record Component accessed by range().

Cursor marking the location or range for the thing to be inserted.

Constructor Detail

DocumentAnnotation	back to summary
public DocumentAnnotation(com.sun.star.text.XTextDocument doc, String name, com.sun.star.text.XTextRange range, boolean absorb)

Method Detail

absorb	back to summary
public boolean absorb() Record Component getter of absorb. Record Component ReferenceMark, Bookmark and TextSection can incorporate a text range. If absorb is true, the text in the range becomes part of the thing. If absorb is false, the thing is inserted at the end of the range.

absorb

back to summary

public boolean absorb()

Record Component getter of absorb.

Record Component: ReferenceMark, Bookmark and TextSection can incorporate a text range. If absorb is true, the text in the range becomes part of the thing. If absorb is false, the thing is inserted at the end of the range.

doc	back to summary
public com.sun.star.text.XTextDocument doc() Record Component getter of doc. Record Component The document

doc

back to summary

public com.sun.star.text.XTextDocument doc()

Record Component getter of doc.

Record Component: The document

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this record is equal to the argument; `false` otherwise.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code. Returns:int a hash code value for this record.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int: a hash code value for this record.

name	back to summary
public String name() Record Component getter of name. Record Component For the ReferenceMark, Bookmark, TextSection. If the name is already in use, LibreOffice may change the name.

name

back to summary

public String name()

Record Component getter of name.

Record Component: For the ReferenceMark, Bookmark, TextSection. If the name is already in use, LibreOffice may change the name.

range	back to summary
public com.sun.star.text.XTextRange range() Record Component getter of range. Record Component Cursor marking the location or range for the thing to be inserted.

range

back to summary

public com.sun.star.text.XTextRange range()

Record Component getter of range.

Record Component: Cursor marking the location or range for the thing to be inserted.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves. Returns:String a string representation of the object.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String: a string representation of the object.

public final Record DocumentAnnotation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail