001: /*
002: * Copyright (c) 2007, intarsys consulting GmbH
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * - Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: *
010: * - Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: *
014: * - Neither the name of intarsys nor the names of its contributors may be used
015: * to endorse or promote products derived from this software without specific
016: * prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
020: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
021: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
022: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
024: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
025: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
026: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
027: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
028: * POSSIBILITY OF SUCH DAMAGE.
029: */
030: package de.intarsys.pdf.pd;
031:
032: import de.intarsys.pdf.cos.COSBasedObject;
033: import de.intarsys.pdf.cos.COSName;
034: import de.intarsys.pdf.cos.COSObject;
035:
036: /**
037: * An annotation implementing a hyperlink behavior within a document.
038: */
039: public class PDLinkAnnotation extends PDAnnotation {
040: /**
041: * The meta class implementation
042: */
043: public static class MetaClass extends PDAnnotation.MetaClass {
044: protected MetaClass(Class instanceClass) {
045: super (instanceClass);
046: }
047:
048: protected COSBasedObject doCreateCOSBasedObject(COSObject object) {
049: return new PDLinkAnnotation(object);
050: }
051: }
052:
053: /** The meta class instance */
054: public static final MetaClass META = new MetaClass(MetaClass.class
055: .getDeclaringClass());
056:
057: public static final COSName CN_Subtype_Link = COSName
058: .constant("Link");
059:
060: public static final COSName DK_Dest = COSName.constant("Dest");
061:
062: public static final COSName DK_H = COSName.constant("H");
063:
064: public static final COSName DK_PA = COSName.constant("PA");
065:
066: public static final COSName DK_QuadPoints = COSName
067: .constant("QuadPoints");
068:
069: public static final COSName CN_H_I = COSName.constant("I");
070:
071: public static final COSName CN_H_N = COSName.constant("N");
072:
073: public static final COSName CN_H_O = COSName.constant("O");
074:
075: public static final COSName CN_H_P = COSName.constant("P");
076:
077: protected PDLinkAnnotation(COSObject object) {
078: super (object);
079: }
080:
081: /*
082: * (non-Javadoc)
083: *
084: * @see de.intarsys.pdf.pd.PDObject#cosGetExpectedSubtype()
085: */
086: protected COSName cosGetExpectedSubtype() {
087: return CN_Subtype_Link;
088: }
089:
090: public String getSubtypeLabel() {
091: return "Link";
092: }
093:
094: public PDDestination getDestination() {
095: COSObject destObj = cosGetField(DK_Dest);
096: if (destObj.isNull()) {
097: return null;
098: }
099: return (PDDestination) PDDestination.META
100: .createFromCos(destObj);
101: }
102:
103: public void setDestination(PDDestination destination) {
104: setFieldObject(DK_Dest, destination);
105: }
106:
107: public COSName getHighlightingMode() {
108: COSName mode = cosGetField(DK_H).asName();
109: if (mode != null) {
110: return mode;
111: }
112: return CN_H_I; // default
113: }
114:
115: public void setHighlightingMode(COSName newHighlightingMode) {
116: if ((newHighlightingMode == null)
117: || CN_H_I.equals(newHighlightingMode)) {
118: cosRemoveField(DK_H);
119: } else {
120: cosSetField(DK_H, newHighlightingMode);
121: }
122: }
123: }
|