|
Side of Software Marker Bar Library 1.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object sos.marker.DefaultMarker
public class DefaultMarker
A default implementation of the Marker
interface that stores the start percentage,
end percentage, and short description in fields.
Constructor Summary | |
---|---|
DefaultMarker(double offset)
Creates an instance of DefaultMarker with start and end locations of offset
and no short description. |
|
DefaultMarker(double start,
double end)
Creates an instance of DefaultMarker with the specified start and end locations
and no short description. |
|
DefaultMarker(double start,
double end,
java.lang.String shortDescription)
Creates an instance of DefaultMarker with the specified start and end locations
and specified short description. |
Method Summary | |
---|---|
double |
getEnd()
Returns this marker's relative end location along the marker bar. |
java.lang.String |
getShortDescription()
Returns a short description describing this marker. |
double |
getStart()
Returns this marker's relative start location along the marker bar. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultMarker(double offset)
DefaultMarker
with start and end locations of offset
and no short description.
offset
- location of this marker, relative to a marker bar
java.lang.IllegalArgumentException
- if offset < 0.0
or offset > 1.0
public DefaultMarker(double start, double end)
DefaultMarker
with the specified start and end locations
and no short description.
start
- start location of this marker, relative to a marker barend
- end location of this marker, relative to a marker bar
java.lang.IllegalArgumentException
- if start < 0.0
, end > 1.0
,
or end < start
public DefaultMarker(double start, double end, java.lang.String shortDescription)
DefaultMarker
with the specified start and end locations
and specified short description.
start
- start location of this marker, relative to a marker barend
- end location of this marker, relative to a marker barshortDescription
- a short description of this marker, which is typically
used as a tooltip
java.lang.IllegalArgumentException
- if start < 0.0
, end > 1.0
,
or end < start
Method Detail |
---|
public double getStart()
Marker
getStart
in interface Marker
Marker.getEnd()
public double getEnd()
Marker
getEnd
in interface Marker
Marker.getStart()
public java.lang.String getShortDescription()
Marker
null
return value indicates that this marker does not
have a short description.
getShortDescription
in interface Marker
null
)
|
Side of Software Marker Bar Library 1.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |