Skip navigation links

com.oracle.outsidein.annotations
Class HighlightAreaAnnotation

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

public class HighlightAreaAnnotation

extends Annotation

Describes a rectangular area to be highlighted in the destination document. Contains the location and visual appearance of the highlighted annotation. This class is only useful when exporting to the HTML5 destination file format.

See Also:

Annotatable.addAreaHighlight(HighlightAreaAnnotation)

Nested Class Summary

static class	HighlightAreaAnnotation.AnnoBorder Describes the attributes of an annotation border such as color and thickness.
static class	HighlightAreaAnnotation.BorderSideValue Identifies a side of an area annotation for purposes of applying a border
static class	HighlightAreaAnnotation.BorderStyleValue The line style of an area annotation's border

Nested classes/interfaces inherited from class com.oracle.outsidein.annotations.Annotation

Annotation.UnitTypeValue

Field Summary

Fields inherited from class com.oracle.outsidein.annotations.Annotation

m_Height, m_Left, m_Opacity, m_Section, m_Top, m_Units, m_UserId, m_Width

Constructor Summary

HighlightAreaAnnotation(long userId, long sectionIx, long top, long left, long width, long height, Annotation.UnitTypeValue units, float opacity, ColorInfo fillColor, HighlightAreaAnnotation.AnnoBorder border, HighlightAreaAnnotation.BorderStyleValue borderStyle)
Creates an area annotation with the specified attributes and location.

Method Summary

HighlightAreaAnnotation.BorderStyleValue	getBorderStyle() Obtains the line style to be used to draw the border of the area annotation
HighlightAreaAnnotation.AnnoBorder	getBottomBorder() Obtains the attributes of the bottom border of the area annotation
protected ColorInfo	getFillColor() Obtains the color to be used to fill the area annotation
HighlightAreaAnnotation.AnnoBorder	getLeftBorder() Obtains the attributes of the left border of the area annotation
net.bitform.oilink.OILinkMessages.HiliteArea	getOILinkHiliteArea() Used internally by the Outside In API and not to be used externally.
HighlightAreaAnnotation.AnnoBorder	getRightBorder() Obtains the attributes of the right border of the area annotation
HighlightAreaAnnotation.AnnoBorder	getTopBorder() Obtains the attributes of the top border of the area annotation
void	setBorder(java.util.EnumSet<HighlightAreaAnnotation.BorderSideValue> side, HighlightAreaAnnotation.AnnoBorder border) Applies a border to the specified side of this area annotation.
void	setBorderStyle(HighlightAreaAnnotation.BorderStyleValue style) Specifies the line style to be used to draw the border of the area annotation
void	setBottomBorder(HighlightAreaAnnotation.AnnoBorder border) Specifies the attributes of the bottom border of the area annotation
protected void	setFillColor(ColorInfo color) specifies the color to be used to fill the area annotation
void	setLeftBorder(HighlightAreaAnnotation.AnnoBorder border) Specifies the attributes of the left border of the area annotation
void	setRightBorder(HighlightAreaAnnotation.AnnoBorder border) Specifies the attributes of the right border of the area annotation
void	setTopBorder(HighlightAreaAnnotation.AnnoBorder border) Specifies the attributes of the top border of the area annotation

Methods inherited from class com.oracle.outsidein.annotations.Annotation

getHeight, getLeft, getOpacity, getSectionIndex, getTop, getUnits, getUserId, getWidth, setHeight, setLeft, setOpacity, setSectionIndex, setTop, setUnits, setUserId, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightAreaAnnotation

public HighlightAreaAnnotation(long userId,
                               long sectionIx,
                               long top,
                               long left,
                               long width,
                               long height,
                               Annotation.UnitTypeValue units,
                               float opacity,
                               ColorInfo fillColor,
                               HighlightAreaAnnotation.AnnoBorder border,
                               HighlightAreaAnnotation.BorderStyleValue borderStyle)

Creates an area annotation with the specified attributes and location.

Parameters:

userId - the numeric id of the user making the annotation

sectionIx - the 0-based index of the sheet/image/slide where the annotation should be rendered

top - the location of the top of this area annotation

left - the location of the left side of this area annotation

width - the width of the area annotation

height - the height of the area annotation

units - the units of measurement to use for top, left, width, and height

opacity - the opacity of the area annotation

fillColor - the color to use to fill the area annotation

border - the border to be applied to all 4 sides of the area annotation

borderStyle - the line style of the area annotation's border

Method Detail

setBorder

public void setBorder(java.util.EnumSet<HighlightAreaAnnotation.BorderSideValue> side,
                      HighlightAreaAnnotation.AnnoBorder border)

Applies a border to the specified side of this area annotation.

Parameters:

side - the side of the area annotation to apply the border

border - the style of the border

getBorderStyle

public HighlightAreaAnnotation.BorderStyleValue getBorderStyle()

Obtains the line style to be used to draw the border of the area annotation

Returns:

the border style

setBorderStyle

public void setBorderStyle(HighlightAreaAnnotation.BorderStyleValue style)

Specifies the line style to be used to draw the border of the area annotation

Parameters:

style - the border style

getTopBorder

public HighlightAreaAnnotation.AnnoBorder getTopBorder()

Obtains the attributes of the top border of the area annotation

Returns:

the border attributes

setTopBorder

public void setTopBorder(HighlightAreaAnnotation.AnnoBorder border)

Specifies the attributes of the top border of the area annotation

Parameters:

border - the border attributes

getLeftBorder

public HighlightAreaAnnotation.AnnoBorder getLeftBorder()

Obtains the attributes of the left border of the area annotation

Returns:

the border attributes

setLeftBorder

public void setLeftBorder(HighlightAreaAnnotation.AnnoBorder border)

Specifies the attributes of the left border of the area annotation

Parameters:

border - the border attributes

getRightBorder

public HighlightAreaAnnotation.AnnoBorder getRightBorder()

Obtains the attributes of the right border of the area annotation

Returns:

the border attributes

setRightBorder

public void setRightBorder(HighlightAreaAnnotation.AnnoBorder border)

Specifies the attributes of the right border of the area annotation

Parameters:

border - the border attributes

getBottomBorder

public HighlightAreaAnnotation.AnnoBorder getBottomBorder()

Obtains the attributes of the bottom border of the area annotation

Returns:

the border attributes

setBottomBorder

public void setBottomBorder(HighlightAreaAnnotation.AnnoBorder border)

Specifies the attributes of the bottom border of the area annotation

Parameters:

border - the border attributes

getFillColor

protected ColorInfo getFillColor()

Obtains the color to be used to fill the area annotation

Returns:

the color

setFillColor

protected void setFillColor(ColorInfo color)

specifies the color to be used to fill the area annotation

Parameters:

color - the color

getOILinkHiliteArea

public net.bitform.oilink.OILinkMessages.HiliteArea getOILinkHiliteArea()

Used internally by the Outside In API and not to be used externally.

Skip navigation links