Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.faceless.pdf2
Class AnnotationStamp

    java.lang.Object
      org.faceless.pdf2.PDFAnnotation
          org.faceless.pdf2.AnnotationStamp

All Implemented Interfaces:
  Cloneable

    public final class AnnotationStamp

extends PDFAnnotation

A "Rubber-Stamp" annotation, which can also contain a longer message in an associated pop-up window. A number of predefined rubber stamps exist, or for custom stamps they can be created from a `PDFCanvas` object. For example, to add a rubber stamp to page, try something like this:

       AnnotationStamp stamp = new AnnotationStamp("stamp.standard.Approved", 1);
       float x = page.getWidth()/2;
       float y = page.getHeight()/2;
       float w = stamp.getRecommendedWidth();
       float h = stamp.getRecommendedHeight();

       stamp.setRectangle(x-(w/2), y-(h/2), x+(w/2), y+(h/2));
       page.addAnnotation(stamp);

Since:
  2.0

Constructor Summary
`AnnotationStamp()` Create a new, uninitialized AnnotationStamp object.
`AnnotationStamp(String type, float opacity)` Create a rubber-stamp annotation which can be added to the page.
`AnnotationStamp(String name, PDFCanvas canvas)` Create a new Stamp from the specified canvas.

Method Summary
`float` | `getRecommendedHeight()` Return the recommended height of this stamp
`float` | `getRecommendedWidth()` Return the recommended width of this stamp
`int` | `getRotate()` Get the rotation of this stamp, as set by `setRotate(int)`
`String` | `getType()` Returns the type of Stamp used.
`void` | `setBlendMode(String mode)` Set the "Blend Mode" of this stamp.
`void` | `setCanvas(String name, PDFCanvas canvas)` Set this stamp to use the specified canvas
`void` | `setRotate(int rotate)` Set the rotation of the specified Stamp.
`void` | `setType(String type, float opacity)` Set the type of the stamp to one of the predefined "standard" types available with Acrobat.
`String` | `toString()`

Methods inherited from class org.faceless.pdf2.PDFAnnotation
`addPropertyChangeListener, addReview, flatten, getAuthor, getColor, getContents, getCreationDate, getInReplyTo, getMetaData, getModifyDate, getOpacity, getPage, getPopup, getRectangle, getReplies, getReviews, getSubject, getUniqueID, hasAppearanceState, isContentLocked, isPositionLocked, isPrintable, isReadOnly, isVisible, removePropertyChangeListener, setAuthor, setColor, setContents, setCreationDate, setInReplyTo, setLocked, setMetaData, setModifyDate, setOpacity, setPage, setPrintable, setReadOnly, setRectangle, setSubject, setUniqueID, setVisible`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### AnnotationStamp

    public AnnotationStamp()

  Create a new, uninitialized AnnotationStamp object. The `setType()` or `setCanvas()` method must be called on this stamp to initialize it;

  Since:
    2.11.6

### AnnotationStamp

    public AnnotationStamp(String type,
                           float opacity)

  Create a rubber-stamp annotation which can be added to the page. Calls the `setType()` method - see that method's API docs for details

  Parameters:
    `type` - the type of stamp
    `opacity` - the opacity of the stamp - anywhere between 0 (for transparent) and 1 (for opaque).
  Throws:
    `IllegalArgumentException` - if the stamp type is unknown
  Since:
    2.0
  See Also:
    `setType(java.lang.String, float)`

### AnnotationStamp

    public AnnotationStamp(String name,
                           PDFCanvas canvas)

  Create a new Stamp from the specified canvas. Calls the `setCanvas()` method - see that method's API docs for details

  Parameters:
    `name` - the name of the stamp
    `canvas` - the canvas to use as the body of the stamp
  Since:
    2.0
  See Also:
    `setCanvas(java.lang.String, org.faceless.pdf2.PDFCanvas)`

Method Detail

### setType

    public void setType(String type,
                        float opacity)

  Set the type of the stamp to one of the predefined "standard" types available with Acrobat. The available types are:

  stamp.stencil.Approved | The word "Approved" in a rubber-stamp style
  stamp.stencil.AsIs | The words "As Is" in a rubber-stamp style
  stamp.stencil.Confidential | The word "Confidential" in a rubber-stamp style
  stamp.stencil.Departmental | The word "Departmental" in a rubber-stamp style
  stamp.stencil.Draft | The word "Draft" in a rubber-stamp style
  stamp.stencil.Experimental | The word "Experimental" in a rubber-stamp style
  stamp.stencil.Expired | The word "Expired" in a rubber-stamp style
  stamp.stencil.Final | The word "Final" in a rubber-stamp style
  stamp.stencil.ForComment | The words "For Comment" in a rubber-stamp style
  stamp.stencil.ForPublicRelease | The words "For Public Release" in a rubber-stamp style
  stamp.stencil.NotApproved | The words "Not Approved" in a rubber-stamp style
  stamp.stencil.NotForPublicRelease | The words "Not For Public Release" in a rubber-stamp style
  stamp.stencil.Sold | The words "As Is" in a rubber-stamp style
  stamp.stencil.TopSecret | The words "Top Secret" in a rubber-stamp style
  stamp.standard.Approved | The word "Approved" inside a box
  stamp.standard.Completed | The word "Completed" inside a box
  stamp.standard.Confidential | The word "Confidential" inside a box
  stamp.standard.Draft | The word "Draft" inside a box
  stamp.standard.Final | The word "Final" inside a box
  stamp.standard.ForComment | The words "For Comment" inside a box
  stamp.standard.ForPublicRelease | The words "For Public Release" inside a box
  stamp.standard.InformationOnly | The words "Information Only" inside a box
  stamp.standard.NotApproved | The words "Not Approved" inside a box
  stamp.standard.NotForPublicRelease | The words "Not For Public Release" inside a box
  stamp.standard.PreliminaryResults | The words "Preliminary Results" inside a box
  stamp.standard.Void | The word "Void" inside a box
  stamp.signhere.Accepted | A green tick
  stamp.signhere.Rejected | A red cross
  stamp.signhere.InitialHere | An arrow with the words "Initial Here"
  stamp.signhere.SignHere | An arrow with the words "Sign Here"
  stamp.signhere.Witness | An arrow with the words "Witness"

  Parameters:
    `type` - the type of stamp - one of the values listed above
    `opacity` - the opacity of the stamp - anywhere between 0 (for transparent) and 1 (for opaque). Note that transparency was only added in Acrobat 5, so earlier viewers will ignore this setting.
  Throws:
    `IllegalArgumentException` - if the stamp type is unknown
  Since:
    2.11.6

### setCanvas

    public void setCanvas(String name,
                          PDFCanvas canvas)

  Set this stamp to use the specified canvas

  Parameters:
    `name` - the name of the stamp
    `canvas` - the canvas to use as the body of the stamp
  Since:
    2.11.6

### getRotate

    public int getRotate()

  Get the rotation of this stamp, as set by `setRotate(int)`

  Since:
    2.11.7

### setRotate

    public void setRotate(int rotate)

  Set the rotation of the specified Stamp. We recommend the page and rectangle of the stamp are set before this method is called. Rotating an already rotated stamp will give the same broken results that you get in Acrobat, due to a specification fault.

  Parameters:
    `rotate` - the rotation in degrees clockwise;
  Since:
    2.11.7

### getType

    public String getType()

  Returns the type of Stamp used. This will probably be a textual description of the contents of the stamp, but is not guaranteed to be.

  Overrides:
    `getType` in class `PDFAnnotation`

### getRecommendedWidth

    public float getRecommendedWidth()

  Return the recommended width of this stamp

### getRecommendedHeight

    public float getRecommendedHeight()

  Return the recommended height of this stamp

### setBlendMode

    public void setBlendMode(String mode)

  Set the "Blend Mode" of this stamp.

  Since:
    2.11.8
  See Also:
    `PDFStyle.setBlendMode(java.lang.String)`

### toString

    public String toString()

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2012 Big Faceless Organization