it.stefanochizzolini.clown.documents.interaction.annotations
Class SoundAnnotation

java.lang.Object
  it.stefanochizzolini.clown.objects.PdfObjectWrapper<PdfDictionary>
      it.stefanochizzolini.clown.documents.interaction.annotations.Annotation
          it.stefanochizzolini.clown.documents.interaction.annotations.SoundAnnotation

public class SoundAnnotation
extends Annotation

Sound annotation [PDF:1.6:8.4.5].

When the annotation is activated, the sound is played.

Since:

0.0.7

Version:

0.0.7

Author:

Stefano Chizzolini (http://www.stefanochizzolini.it)

Nested Class Summary

static class

SoundAnnotation.IconTypeEnum Icon to be used in displaying the annotation [PDF:1.6:8.4.5].

Nested classes/interfaces inherited from class it.stefanochizzolini.clown.documents.interaction.annotations.Annotation

Annotation.FlagsEnum

Constructor Summary

SoundAnnotation(Page page, Rectangle2D box, Sound sound)

SoundAnnotation(PdfDirectObject baseObject, PdfIndirectObject container)

Method Summary

SoundAnnotation	clone(Document context) Gets a clone of the object, registered inside the given document context.
SoundAnnotation.IconTypeEnum	getIconType() Gets the icon to be used in displaying the annotation.
Sound	getSound() Gets the sound to be played.
void	setIconType(SoundAnnotation.IconTypeEnum value)
void	setSound(Sound value)

Methods inherited from class it.stefanochizzolini.clown.documents.interaction.annotations.Annotation

getAction, getActions, getAppearance, getBorder, getBox, getFlags, getModificationDate, getName, getPage, getText, isPrintable, isVisible, setAction, setActions, setAppearance, setBorder, setBox, setFlags, setModificationDate, setName, setPage, setPrintable, setText, setVisible, wrap, wrap

Methods inherited from class it.stefanochizzolini.clown.objects.PdfObjectWrapper

delete, getBaseDataObject, getBaseObject, getContainer, getDocument, getFile, setBaseObject, setContainer, update

Methods inherited from class java.lang.Object

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

Constructor Detail

SoundAnnotation

public SoundAnnotation(Page page,
                       Rectangle2D box,
                       Sound sound)

SoundAnnotation

public SoundAnnotation(PdfDirectObject baseObject,
                       PdfIndirectObject container)

Method Detail

clone

public SoundAnnotation clone(Document context)

Description copied from class: PdfObjectWrapper

Gets a clone of the object, registered inside the given document context.

Overrides:

clone in class Annotation

Parameters:

context - Which document the clone has to be registered in.

getIconType

public SoundAnnotation.IconTypeEnum getIconType()

Gets the icon to be used in displaying the annotation.

getSound

public Sound getSound()

Gets the sound to be played.

setIconType

public void setIconType(SoundAnnotation.IconTypeEnum value)

See Also:

getIconType()

setSound

public void setSound(Sound value)

See Also:

getSound()