/**
* Copyright (c) 2004, www.pdfbox.org
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of pdfbox; nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://www.pdfbox.org
*
*/
package org.pdfbox.pdmodel.interactive.action;
import org.pdfbox.cos.COSBase;
import org.pdfbox.cos.COSDictionary;
import org.pdfbox.pdmodel.common.COSObjectable;
import org.pdfbox.pdmodel.interactive.action.type.PDAction;
/**
* This class represents a page object's dictionary of actions
* that occur due to events.
*
* @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
* @author Panagiotis Toumasis (ptoumasis@mail.gr)
* @version $Revision: 1.2 $
*/
public class PDPageAdditionalActions implements COSObjectable
{
private COSDictionary actions;
/**
* Default constructor.
*/
public PDPageAdditionalActions()
{
actions = new COSDictionary();
}
/**
* Constructor.
*
* @param a The action dictionary.
*/
public PDPageAdditionalActions( COSDictionary a )
{
actions = a;
}
/**
* Convert this standard java object to a COS object.
*
* @return The cos object that matches this Java object.
*/
public COSBase getCOSObject()
{
return actions;
}
/**
* Convert this standard java object to a COS object.
*
* @return The cos object that matches this Java object.
*/
public COSDictionary getCOSDictionary()
{
return actions;
}
/**
* This will get an action to be performed when the page
* is opened. This action is independent of any that may be
* defined by the OpenAction entry in the document catalog,
* and is executed after such an action.
*
* @return The O entry of page object's additional actions dictionary.
*/
public PDAction getO()
{
COSDictionary o = (COSDictionary)actions.getDictionaryObject( "O" );
PDAction retval = null;
if( o != null )
{
retval = PDActionFactory.createAction( o );
}
return retval;
}
/**
* This will set an action to be performed when the page
* is opened. This action is independent of any that may be
* defined by the OpenAction entry in the document catalog,
* and is executed after such an action.
*
* @param o The action to be performed.
*/
public void setO( PDAction o )
{
actions.setItem( "O", o );
}
/**
* This will get an action to be performed when the page
* is closed. This action applies to the page being closed,
* and is executed before any other page opened.
*
* @return The C entry of page object's additional actions dictionary.
*/
public PDAction getC()
{
COSDictionary c = (COSDictionary)actions.getDictionaryObject( "C" );
PDAction retval = null;
if( c != null )
{
retval = PDActionFactory.createAction( c );
}
return retval;
}
/**
* This will set an action to be performed when the page
* is closed. This action applies to the page being closed,
* and is executed before any other page opened.
*
* @param c The action to be performed.
*/
public void setC( PDAction c )
{
actions.setItem( "C", c );
}
}