KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > interactive > annotation > PDBorderEffectDictionary


1 /**
2  * Copyright (c) 2003-2005, www.pdfbox.org
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * 3. Neither the name of pdfbox; nor the names of its
14  * contributors may be used to endorse or promote products derived from this
15  * software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * http://www.pdfbox.org
29  *
30  */
31 package org.pdfbox.pdmodel.interactive.annotation;
32
33 import org.pdfbox.cos.COSBase;
34 import org.pdfbox.cos.COSDictionary;
35
36 import org.pdfbox.pdmodel.common.COSObjectable;
37
38 /**
39  * This class represents a PDF /BE entry the border effect dictionary.
40  *
41  * @author Paul King
42  * @version $Revision: 1.1 $
43  */
44 public class PDBorderEffectDictionary implements COSObjectable
45 {
46
47     /*
48      * The various values of the effect applied to the border as defined in the
49      * PDF 1.6 reference Table 8.14
50      */
51
52     /**
53      * Constant for the name for no effect.
54      */
55     public static final String JavaDoc STYLE_SOLID = "S";
56
57     /**
58      * Constant for the name of a cloudy effect.
59      */
60     public static final String JavaDoc STYLE_CLOUDY = "C";
61
62     private COSDictionary dictionary;
63
64     /**
65      * Constructor.
66      */
67     public PDBorderEffectDictionary()
68     {
69         dictionary = new COSDictionary();
70     }
71
72     /**
73      * Constructor.
74      *
75      * @param dict
76      * a border style dictionary.
77      */
78     public PDBorderEffectDictionary( COSDictionary dict )
79     {
80         dictionary = dict;
81     }
82
83     /**
84      * returns the dictionary.
85      *
86      * @return the dictionary
87      */
88     public COSDictionary getDictionary()
89     {
90         return dictionary;
91     }
92
93     /**
94      * returns the dictionary.
95      *
96      * @return the dictionary
97      */
98     public COSBase getCOSObject()
99     {
100         return dictionary;
101     }
102
103     /**
104      * This will set the intensity of the applied effect.
105      *
106      * @param i
107      * the intensity of the effect values 0 to 2
108      */
109     public void setIntensity( float i )
110     {
111         getDictionary().setFloat( "I", i );
112     }
113
114     /**
115      * This will retrieve the intensity of the applied effect.
116      *
117      * @return the intensity value 0 to 2
118      */
119     public float getIntensity()
120     {
121         return getDictionary().getFloat( "I", 0 );
122     }
123
124     /**
125      * This will set the border effect, see the STYLE_* constants for valid values.
126      *
127      * @param s
128      * the border effect to use
129      */
130     public void setStyle( String JavaDoc s )
131     {
132         getDictionary().setName( "S", s );
133     }
134
135     /**
136      * This will retrieve the border effect, see the STYLE_* constants for valid
137      * values.
138      *
139      * @return the effect of the border
140      */
141     public String JavaDoc getStyle()
142     {
143         return getDictionary().getNameAsString( "S", STYLE_SOLID );
144     }
145
146 }
Popular Tags