|
Oracle Outside In Java API Reference 8.5.4 E91699-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.oracle.outsidein.annotations.Annotation
com.oracle.outsidein.annotations.StampAnnotation
public class StampAnnotation
Describes an image to be overlayed on top of the destination document. Only useful when exporting to the HTML5 destination file format.
Annotatable.addStampAnnotation(StampAnnotation)
Nested Class Summary | |
---|---|
static class |
StampAnnotation.SizingMethodValue The method used to scale the stamp image. |
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 | |
---|---|
StampAnnotation(long userId, long sectionIx, long top, long left, long width, long height, Annotation.UnitTypeValue units, float opacity, StampAnnotation.SizingMethodValue sizeMode, java.lang.String stampName) Creates a stamp annotation with the specified attributes and location. |
Method Summary | |
---|---|
net.bitform.oilink.OILinkMessages.HiliteStamp |
getOILinkHiliteStamp() Used internally by the Outside In API and not to be used externally. |
StampAnnotation.SizingMethodValue |
getSizeMode() Obtains the method of sizing the source image. |
java.lang.String |
getStampName() Obtains the String name used to reference the stamp image file. |
void |
setSizeMode(StampAnnotation.SizingMethodValue mode) Specifies the method of sizing the source image. |
void |
setStampName(java.lang.String name) Specifies the String name used to reference the stamp image file. |
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 |
---|
public StampAnnotation(long userId, long sectionIx, long top, long left, long width, long height, Annotation.UnitTypeValue units, float opacity, StampAnnotation.SizingMethodValue sizeMode, java.lang.String stampName)
userId
- the numeric id of the user making the annotationsectionIx
- the 0-based index of the sheet/image/slide where the annotation should be renderedtop
- the location of the top of this area annotationleft
- the location of the left side of this area annotationwidth
- the width of the area annotationheight
- the height of the area annotationunits
- the units of measurement to use for top
, left
, width
, and height
opacity
- the opacity of the area annotationsizeMode
- the mode used to scale the stamp imagestampName
- the name referencing the stamp imageMethod Detail |
---|
public StampAnnotation.SizingMethodValue getSizeMode()
public void setSizeMode(StampAnnotation.SizingMethodValue mode)
mode
- the sizing methodpublic java.lang.String getStampName()
public void setStampName(java.lang.String name)
name
- the name referencing of the stamp imageAnnotatable.addStampImageFile(java.util.Map)
, Annotatable.addStampImageURL(java.util.Map)
public net.bitform.oilink.OILinkMessages.HiliteStamp getOILinkHiliteStamp()
|
Oracle Outside In Java API Reference 8.5.4 E91699-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |