PDF Clown
0.1.2

org.pdfclown.documents.interaction.annotations
Class Sound

java.lang.Object
  extended by org.pdfclown.objects.PdfObjectWrapper<PdfDictionary>
      extended by org.pdfclown.documents.interaction.annotations.Annotation
          extended by org.pdfclown.documents.interaction.annotations.Sound
All Implemented Interfaces:
Cloneable, ILayerable, IPdfObjectWrapper

@PDF(value=PDF12)
public final class Sound
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.1.2, 12/21/12
Author:
Stefano Chizzolini (http://www.stefanochizzolini.it)

Nested Class Summary
static class Sound.IconTypeEnum
          Icon to be used in displaying the annotation [PDF:1.6:8.4.5].
 
Nested classes/interfaces inherited from class org.pdfclown.documents.interaction.annotations.Annotation
Annotation.FlagsEnum
 
Constructor Summary
Sound(Page page, Rectangle2D box, String text, Sound content)
           
 
Method Summary
 Sound clone(Document context)
          Gets a clone of the object, registered inside the given document context.
 Sound getContent()
          Gets the sound to be played.
 Sound.IconTypeEnum getIconType()
          Gets the icon to be used in displaying the annotation.
 void setContent(Sound value)
           
 void setIconType(Sound.IconTypeEnum value)
           
 
Methods inherited from class org.pdfclown.documents.interaction.annotations.Annotation
delete, getAction, getActions, getAppearance, getBorder, getBox, getColor, getFlags, getLayer, getModificationDate, getName, getPage, getText, isPrintable, isVisible, setAction, setActions, setAppearance, setBorder, setBox, setColor, setFlags, setLayer, setModificationDate, setName, setPrintable, setText, setVisible, wrap
 
Methods inherited from class org.pdfclown.objects.PdfObjectWrapper
checkCompatibility, equals, exists, getBaseDataObject, getBaseObject, getBaseObject, getContainer, getDataContainer, getDocument, getFile, getMetadata, retrieveName, retrieveNamedBaseObject, setBaseObject, setMetadata
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Sound

public Sound(Page page,
             Rectangle2D box,
             String text,
             Sound content)
Method Detail

clone

public Sound 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 Sound.IconTypeEnum getIconType()
Gets the icon to be used in displaying the annotation.


getContent

public Sound getContent()
Gets the sound to be played.


setIconType

public void setIconType(Sound.IconTypeEnum value)
See Also:
getIconType()

setContent

public void setContent(Sound value)
See Also:
getContent()

PDF Clown
0.1.2

Project home page

Copyright © 2006-2013 Stefano Chizzolini. Some Rights Reserved.
This documentation is available under the terms of the GNU Free Documentation License.