|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Cursor
Defines a cursor, which is a temporary marker in time defined somewhere on the captured data.
Method Summary | |
---|---|
void |
clear()
Clears this cursor, making it undefined. |
Cursor |
clone()
Creates a clone of this cursor. |
Color |
getColor()
Returns the cursor color. |
int |
getIndex()
Returns the index of this cursor. |
String |
getLabel()
Returns the label of this cursor. |
long |
getTimestamp()
Returns the time stamp of this cursor. |
boolean |
hasLabel()
Returns whether or not this cursor has a label. |
boolean |
inArea(long aTimestamp,
double aDelta)
Returns whether the time stamp of this cursor falls within the range of a given time stamp. |
boolean |
isDefined()
Returns whether or not this cursor has a defined time stamp. |
void |
setColor(Color aColor)
Sets the color of this cursor. |
void |
setLabel(String aLabel)
Sets the label. |
void |
setTimestamp(long aTimestamp)
Sets the time stamp for this cursor. |
Method Detail |
---|
void clear()
Cursor clone()
Color getColor()
null
.int getIndex()
String getLabel()
null
if no label is (yet) defined.long getTimestamp()
IllegalStateException
- in case this cursor is undefined.isDefined()
boolean hasLabel()
true
if there's a label assigned to this cursor,
false
otherwise.boolean inArea(long aTimestamp, double aDelta)
aTimestamp
- the time stamp to check against;aDelta
- the delta deviation between this time stamp and the given time
stamp, >= 0.
true
if this cursor is within the area of the given
time stamp, false
otherwise.boolean isDefined()
true
if this cursor has a defined time stamp,
false
otherwise.void setColor(Color aColor)
aColor
- the color to set, cannot be null
.void setLabel(String aLabel)
aLabel
- the label to setvoid setTimestamp(long aTimestamp)
aTimestamp
- the time stamp to set, >= 0.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |