/*
Copyright 2008-2010 Stefano Chizzolini. http://www.pdfclown.org
Contributors:
* Stefano Chizzolini (original code developer, http://www.stefanochizzolini.it)
This file should be part of the source code distribution of "PDF Clown library"
(the Program): see the accompanying README files for more info.
This Program is free software; you can redistribute it and/or modify it under the terms
of the GNU Lesser General Public License as published by the Free Software Foundation;
either version 3 of the License, or (at your option) any later version.
This Program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY,
either expressed or implied; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the License for more details.
You should have received a copy of the GNU Lesser General Public License along with this
Program (see README files); if not, go to the GNU website (http://www.gnu.org/licenses/).
Redistribution and use, with or without modification, are permitted provided that such
redistributions retain the above copyright notice, license and disclaimer, along with
this list of conditions.
*/
package org.pdfclown.documents.interaction.annotations;
import org.pdfclown.PDF;
import org.pdfclown.VersionEnum;
import org.pdfclown.documents.Document;
import org.pdfclown.documents.Page;
import org.pdfclown.documents.fileSpecs.FileSpec;
import org.pdfclown.objects.PdfDirectObject;
import org.pdfclown.objects.PdfIndirectObject;
import org.pdfclown.objects.PdfName;
import org.pdfclown.util.NotImplementedException;
import java.awt.geom.Rectangle2D;
/**
File attachment annotation [PDF:1.6:8.4.5].
<p>It represents a reference to a file, which typically is embedded in the PDF file.</p>
@author Stefano Chizzolini (http://www.stefanochizzolini.it)
@since 0.0.7
@version 0.1.0
*/
@PDF(VersionEnum.PDF13)
public final class FileAttachment
extends Annotation
{
// <class>
// <classes>
/**
Icon to be used in displaying the annotation [PDF:1.6:8.4.5].
*/
public enum IconTypeEnum
{
// <class>
// <static>
// <fields>
/**
Graph.
*/
Graph(PdfName.Graph),
/**
Paper clip.
*/
PaperClip(PdfName.Paperclip),
/**
Push pin.
*/
PushPin(PdfName.PushPin),
/**
Tag.
*/
Tag(PdfName.Tag);
// </fields>
// <interface>
// <public>
/**
Gets the icon type corresponding to the given value.
*/
public static IconTypeEnum get(
PdfName value
)
{
for(IconTypeEnum iconType : IconTypeEnum.values())
{
if(iconType.getCode().equals(value))
return iconType;
}
return null;
}
// </public>
// </interface>
// </static>
// <dynamic>
// <fields>
private final PdfName code;
// </fields>
// <constructors>
private IconTypeEnum(
PdfName code
)
{this.code = code;}
// </constructors>
// <interface>
// <public>
public PdfName getCode(
)
{return code;}
// </public>
// </interface>
// </dynamic>
// </class>
}
// </classes>
// <dynamic>
// <constructors>
public FileAttachment(
Page page,
Rectangle2D box,
FileSpec fileSpec
)
{
super(
page.getDocument(),
PdfName.FileAttachment,
box,
page
);
setFileSpec(fileSpec);
}
public FileAttachment(
PdfDirectObject baseObject,
PdfIndirectObject container
)
{super(baseObject,container);}
// </constructors>
// <interface>
// <public>
@Override
public FileAttachment clone(
Document context
)
{throw new NotImplementedException();}
/**
Gets the file associated with this annotation.
*/
public FileSpec getFileSpec(
)
{
/*
NOTE: 'FS' entry MUST exist.
*/
return new FileSpec(getBaseDataObject().get(PdfName.FS),getContainer(),null);
}
/**
Gets the icon to be used in displaying the annotation.
*/
public IconTypeEnum getIconType(
)
{
/*
NOTE: 'Name' entry may be undefined.
*/
PdfName nameObject = (PdfName)getBaseDataObject().get(PdfName.Name);
if(nameObject == null)
return IconTypeEnum.PushPin;
return IconTypeEnum.get(nameObject);
}
/**
@see #getFileSpec()
*/
public void setFileSpec(
FileSpec value
)
{getBaseDataObject().put(PdfName.FS, value.getBaseObject());}
/**
@see #getIconType()
*/
public void setIconType(
IconTypeEnum value
)
{getBaseDataObject().put(PdfName.Name, value.getCode());}
// </public>
// </interface>
// </dynamic>
// </class>
}