PDActionSound (Apache PDFBox 2.0.1 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.pdfbox.pdmodel.interactive.action.PDAction
- - org.apache.pdfbox.pdmodel.interactive.action.PDActionSound

All Implemented Interfaces:

COSObjectable, PDDestinationOrAction
```
public class PDActionSound
extends PDAction
```
This represents a Sound action that can be executed in a PDF document

Author:

Timur Kamalov

Field Summary

Fields
Modifier and Type Field and Description

static String SUB_TYPE
This type of action this object represents.
- Fields inherited from class org.apache.pdfbox.pdmodel.interactive.action.PDAction
  action, TYPE

Constructor Summary

Constructors
Constructor and Description

PDActionSound()
Default constructor.

PDActionSound(COSDictionary a)
Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getS()` This will get the type of action that the actions dictionary describes.
`void`	`setS(String s)` This will set the type of action that the actions dictionary describes.

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.action.PDAction
getCOSObject, getNext, getSubType, getType, setNext, setSubType, setType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SUB_TYPE
```
public static final String SUB_TYPE
```
    This type of action this object represents.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - PDActionSound
```
public PDActionSound()
```
    Default constructor.
  - PDActionSound
```
public PDActionSound(COSDictionary a)
```
    Constructor.
    
    Parameters:
    a - The action dictionary.
- Method Detail
  - getS
```
public String getS()
```
    This will get the type of action that the actions dictionary describes. It must be Sound for a Sound action.
    
    Returns:
    The S entry of the specific Sound action dictionary.
  - setS
```
public void setS(String s)
```
    This will set the type of action that the actions dictionary describes. It must be Sound for a Sound action.
    
    Parameters:
    s - The Sound action.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.