Class TextSelection
- java.lang.Object
-
- org.odftoolkit.odfdom.changes.TextSelection
-
- Direct Known Subclasses:
TextFieldSelection
,TextHyperlinkSelection
,TextSpanSelection
public abstract class TextSelection extends Object
- Author:
- svante.schubertATgmail.com
-
-
Field Summary
Fields Modifier and Type Field Description protected List<Integer>
mEndPosition
protected OdfElement
mSelectionElement
protected List<Integer>
mStartPosition
protected String
mUrl
-
Constructor Summary
Constructors Constructor Description TextSelection()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(Object o)
int compareTo(T o) Compares this object with the specified object for order.List<Integer>
getEndPosition()
Returns the endPosition of the Anchor element.OdfElement
getSelectionElement()
List<Integer>
getStartPosition()
Returns the startPosition of the Anchor element.String
getURL()
boolean
hasUrl()
Hyperlinks need to keep their URL even if merged with spans.static boolean
overLapping(TextSelection s1, TextSelection s2)
Test if one of the two given TextSelection is overlappingvoid
setEndPosition(List<Integer> endPosition)
void
setURL(String url)
Even on a spanSelection a URL must be able to be set, in case an anchor is merged into it
-
-
-
Method Detail
-
getStartPosition
public List<Integer> getStartPosition()
Returns the startPosition of the Anchor element.- Returns:
- the startPosition of the Anchor element.
-
getEndPosition
public List<Integer> getEndPosition()
Returns the endPosition of the Anchor element.- Returns:
- the endPosition of the Anchor element.
-
setEndPosition
public void setEndPosition(List<Integer> endPosition)
- Parameters:
endPosition
- end position of the Anchor element.
-
getSelectionElement
public OdfElement getSelectionElement()
- Returns:
- the element being used for selecting the text.
-
hasUrl
public boolean hasUrl()
Hyperlinks need to keep their URL even if merged with spans.- Returns:
- true if a text hyperlink, or a span a hyperlink was merged into
-
getURL
public String getURL()
- Returns:
- the hyperlink URL
-
setURL
public void setURL(String url)
Even on a spanSelection a URL must be able to be set, in case an anchor is merged into it
-
overLapping
public static boolean overLapping(TextSelection s1, TextSelection s2)
Test if one of the two given TextSelection is overlapping
-
compareTo
public int compareTo(Object o)
int compareTo(T o) Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.
Finally, the implementor must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.
It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."
In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.
Parameters: o - the object to be compared. Returns: a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Throws: ClassCastException - if the specified object's type prevents it from being compared to this object.
-
-