Skip navigation links

com.oracle.outsidein.annotations
Class Annotation

java.lang.Object
com.oracle.outsidein.annotations.Annotation

Direct Known Subclasses:

HighlightAreaAnnotation, StampAnnotation

public abstract class Annotation

extends java.lang.Object

Abstract base class for HighlightTextAnnotation and HighlightAreaAnnotation.

Nested Class Summary

static class

Annotation.UnitTypeValue Units that specify how the dimensions and location values of the annotation should be interpreted.

Field Summary

protected long	m_Height
protected long	m_Left
protected float	m_Opacity
protected long	m_Section
protected long	m_Top
protected Annotation.UnitTypeValue	m_Units
protected long	m_UserId
protected long	m_Width

Method Summary

long	getHeight() Obtains the height of the annotation object.
long	getLeft() Obtains the left coordinate or column where the annotation should be placed.
float	getOpacity() Obtains the opacity of the annotation in the range of 0.0 to 1.0.
long	getSectionIndex() Obtains the 0-based index of the sheet/image/slide where the annotation will be applied.
long	getTop() Obtains the top coordinate or row where the annotation should be placed.
Annotation.UnitTypeValue	getUnits() Obtains the units of measurement used for the dimensions and location of the annotation object.
long	getUserId() Obtains the numeric user Id associated with this annotation object.
long	getWidth() Obtains the width of the annotation object.
void	setHeight(long height) Specifies the height of the annotation object.
void	setLeft(long left) Specifies the left coordinate or column where the annotation should be placed.
void	setOpacity(float opacity) Specifies the opacity of the annotation in the range of 0.0 to 1.0.
void	setSectionIndex(long section) Specifies the 0-based index of the sheet/image/slide where the annotation will be applied.
void	setTop(long top) Specifies the top coordinate or row where the annotation should be placed.
void	setUnits(Annotation.UnitTypeValue units) Specifies the units of measurement used for the dimensions and location of the annotation object.
void	setUserId(long userId) Specifies the numeric user Id to associate with this annotation object.
void	setWidth(long width) Specifies the width of the annotation object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_Section

protected long m_Section

m_Top

protected long m_Top

m_Left

protected long m_Left

m_Width

protected long m_Width

m_Height

protected long m_Height

m_Units

protected Annotation.UnitTypeValue m_Units

m_UserId

protected long m_UserId

m_Opacity

protected float m_Opacity

Method Detail

getSectionIndex

public long getSectionIndex()

Obtains the 0-based index of the sheet/image/slide where the annotation will be applied.

Returns:

the index of the section

setSectionIndex

public void setSectionIndex(long section)

Specifies the 0-based index of the sheet/image/slide where the annotation will be applied.

Parameters:

section - the index of the section

getTop

public long getTop()

Obtains the top coordinate or row where the annotation should be placed. The value is in units as specified in setUnits(UnitTypeValue).

Returns:

the value of the top coordinate

setTop

public void setTop(long top)

Specifies the top coordinate or row where the annotation should be placed. The value is in units as specified in setUnits(UnitTypeValue).

Parameters:

top - the value of the top coordinate

getLeft

public long getLeft()

Obtains the left coordinate or column where the annotation should be placed. The value is in units as specified in setUnits(UnitTypeValue).

Returns:

the value of the left coordinate

setLeft

public void setLeft(long left)

Specifies the left coordinate or column where the annotation should be placed. The value is in units as specified in setUnits(UnitTypeValue).

Parameters:

left - the value of the left coordinate

getWidth

public long getWidth()

Obtains the width of the annotation object. The value is in units as specified in setUnits(UnitTypeValue).

Returns:

the width value

setWidth

public void setWidth(long width)

Specifies the width of the annotation object. The value is in units as specified in setUnits(UnitTypeValue).

Parameters:

width - the width value

getHeight

public long getHeight()

Obtains the height of the annotation object. The value is in units as specified in setUnits(UnitTypeValue).

Returns:

the height value

setHeight

public void setHeight(long height)

Specifies the height of the annotation object. The value is in units as specified in setUnits(UnitTypeValue).

Parameters:

height - the height value

getUnits

public Annotation.UnitTypeValue getUnits()

Obtains the units of measurement used for the dimensions and location of the annotation object.

Returns:

the units of measurement

setUnits

public void setUnits(Annotation.UnitTypeValue units)

Specifies the units of measurement used for the dimensions and location of the annotation object.

Parameters:

units - the units of measurement

getUserId

public long getUserId()

Obtains the numeric user Id associated with this annotation object.

Returns:

the numeric user Id

setUserId

public void setUserId(long userId)

Specifies the numeric user Id to associate with this annotation object.

Parameters:

userId - the numeric user Id

getOpacity

public float getOpacity()

Obtains the opacity of the annotation in the range of 0.0 to 1.0. 0 is completely invisible. 1 is fully opaque.

Returns:

the opacity of the annotation

setOpacity

public void setOpacity(float opacity)
                throws OutsideInException

Specifies the opacity of the annotation in the range of 0.0 to 1.0. 0 is completely invisible. 1 is fully opaque.

Parameters:

opacity - the opacity of the annotation

Throws:

OutsideInException

Skip navigation links