org.openimaj.vis.timeline

Enum Timeline.TimelineMarkerType

java.lang.Object

java.lang.Enum<Timeline.TimelineMarkerType>

org.openimaj.vis.timeline.Timeline.TimelineMarkerType

All Implemented Interfaces:

Serializable, Comparable<Timeline.TimelineMarkerType>

Enclosing class:

Timeline

public static enum Timeline.TimelineMarkerType
extends Enum<Timeline.TimelineMarkerType>

Different type of markers.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLAG Draws a marker with a little flag at the top
LABEL Draws a marker with a little flag showing some text

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	drawMarker(Timeline.TimelineMarker m, MBFImage image, int xPos, int height) Draws this marker into the given graphics context at the given position and with the given length.
protected static Float[]	getOpposingColour(Float[] c) Returns an opposing colour
static Timeline.TimelineMarkerType	valueOf(String name) Returns the enum constant of this type with the specified name.
static Timeline.TimelineMarkerType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LABEL

public static final Timeline.TimelineMarkerType LABEL

Draws a marker with a little flag showing some text

FLAG

public static final Timeline.TimelineMarkerType FLAG

Draws a marker with a little flag at the top

Method Detail

values

public static Timeline.TimelineMarkerType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Timeline.TimelineMarkerType c : Timeline.TimelineMarkerType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Timeline.TimelineMarkerType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

drawMarker

public abstract void drawMarker(Timeline.TimelineMarker m,
              MBFImage image,
              int xPos,
              int height)

Draws this marker into the given graphics context at the given position and with the given length.

Parameters:

m - The marker

image - The image to draw to

xPos - The position

height - The length to draw the marker

getOpposingColour

protected static Float[] getOpposingColour(Float[] c)

Returns an opposing colour

Parameters:

c - The colour to oppose

Returns:

An opposing colour