KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > pdf > PdfLayerMembership


1 /*
2  * Copyright 2004 by Paulo Soares.
3  *
4  * The contents of this file are subject to the Mozilla Public License Version 1.1
5  * (the "License"); you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the License.
11  *
12  * The Original Code is 'iText, a free JAVA-PDF library'.
13  *
14  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
15  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
16  * All Rights Reserved.
17  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
18  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
19  *
20  * Contributor(s): all the names of the contributors are added in the source code
21  * where applicable.
22  *
23  * Alternatively, the contents of this file may be used under the terms of the
24  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
25  * provisions of LGPL are applicable instead of those above. If you wish to
26  * allow use of your version of this file only under the terms of the LGPL
27  * License and not to allow others to use your version of this file under
28  * the MPL, indicate your decision by deleting the provisions above and
29  * replace them with the notice and other provisions required by the LGPL.
30  * If you do not delete the provisions above, a recipient may use your version
31  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
32  *
33  * This library is free software; you can redistribute it and/or modify it
34  * under the terms of the MPL as stated above or under the terms of the GNU
35  * Library General Public License as published by the Free Software Foundation;
36  * either version 2 of the License, or any later version.
37  *
38  * This library is distributed in the hope that it will be useful, but WITHOUT
39  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
40  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
41  * details.
42  *
43  * If you didn't download this code from the following link, you should check if
44  * you aren't using an obsolete version:
45  * http://www.lowagie.com/iText/
46  */
47
48 package com.lowagie.text.pdf;
49
50 import java.util.Collection JavaDoc;
51 import java.util.HashSet JavaDoc;
52
53 /**
54  * Content typically belongs to a single optional content group,
55  * and is visible when the group is <B>ON</B> and invisible when it is <B>OFF</B>. To express more
56  * complex visibility policies, content should not declare itself to belong to an optional
57  * content group directly, but rather to an optional content membership dictionary
58  * represented by this class.
59  *
60  * @author Paulo Soares (psoares@consiste.pt)
61  */
62 public class PdfLayerMembership extends PdfDictionary implements PdfOCG {
63     
64     /**
65      * Visible only if all of the entries are <B>ON</B>.
66      */
67     public static final PdfName ALLON = new PdfName("AllOn");
68     /**
69      * Visible if any of the entries are <B>ON</B>.
70      */
71     public static final PdfName ANYON = new PdfName("AnyOn");
72     /**
73      * Visible if any of the entries are <B>OFF</B>.
74      */
75     public static final PdfName ANYOFF = new PdfName("AnyOff");
76     /**
77      * Visible only if all of the entries are <B>OFF</B>.
78      */
79     public static final PdfName ALLOFF = new PdfName("AllOff");
80
81     PdfIndirectReference ref;
82     PdfArray members = new PdfArray();
83     HashSet JavaDoc layers = new HashSet JavaDoc();
84     
85     /**
86      * Creates a new, empty, membership layer.
87      * @param writer the writer
88      */
89     public PdfLayerMembership(PdfWriter writer) {
90         super(PdfName.OCMD);
91         put(PdfName.OCGS, members);
92         ref = writer.getPdfIndirectReference();
93     }
94     
95     /**
96      * Gets the <CODE>PdfIndirectReference</CODE> that represents this membership layer.
97      * @return the <CODE>PdfIndirectReference</CODE> that represents this layer
98      */
99     public PdfIndirectReference getRef() {
100         return ref;
101     }
102     
103     /**
104      * Adds a new member to the layer.
105      * @param layer the new member to the layer
106      */
107     public void addMember(PdfLayer layer) {
108         if (!layers.contains(layer)) {
109             members.add(layer.getRef());
110             layers.add(layer);
111         }
112     }
113     
114     /**
115      * Gets the member layers.
116      * @return the member layers
117      */
118     public Collection JavaDoc getLayers() {
119         return layers;
120     }
121     
122     /**
123      * Sets the visibility policy for content belonging to this
124      * membership dictionary. Possible values are ALLON, ANYON, ANYOFF and ALLOFF.
125      * The default value is ANYON.
126      * @param type the visibility policy
127      */
128     public void setVisibilityPolicy(PdfName type) {
129         put(PdfName.P, type);
130     }
131     
132     /**
133      * Gets the dictionary representing the membership layer. It just returns <CODE>this</CODE>.
134      * @return the dictionary representing the layer
135      */
136     public PdfObject getPdfObject() {
137         return this;
138     }
139 }
140
Popular Tags