001: /*
002: * Copyright 2004 by Paulo Soares.
003: *
004: * The contents of this file are subject to the Mozilla Public License Version 1.1
005: * (the "License"); you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
007: *
008: * Software distributed under the License is distributed on an "AS IS" basis,
009: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
010: * for the specific language governing rights and limitations under the License.
011: *
012: * The Original Code is 'iText, a free JAVA-PDF library'.
013: *
014: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
015: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
016: * All Rights Reserved.
017: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
018: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
019: *
020: * Contributor(s): all the names of the contributors are added in the source code
021: * where applicable.
022: *
023: * Alternatively, the contents of this file may be used under the terms of the
024: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
025: * provisions of LGPL are applicable instead of those above. If you wish to
026: * allow use of your version of this file only under the terms of the LGPL
027: * License and not to allow others to use your version of this file under
028: * the MPL, indicate your decision by deleting the provisions above and
029: * replace them with the notice and other provisions required by the LGPL.
030: * If you do not delete the provisions above, a recipient may use your version
031: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
032: *
033: * This library is free software; you can redistribute it and/or modify it
034: * under the terms of the MPL as stated above or under the terms of the GNU
035: * Library General Public License as published by the Free Software Foundation;
036: * either version 2 of the License, or any later version.
037: *
038: * This library is distributed in the hope that it will be useful, but WITHOUT
039: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
040: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
041: * details.
042: *
043: * If you didn't download this code from the following link, you should check if
044: * you aren't using an obsolete version:
045: * http://www.lowagie.com/iText/
046: */
047:
048: package com.lowagie.text.pdf;
049:
050: import java.util.Collection;
051: import java.util.HashSet;
052:
053: /**
054: * Content typically belongs to a single optional content group,
055: * and is visible when the group is <B>ON</B> and invisible when it is <B>OFF</B>. To express more
056: * complex visibility policies, content should not declare itself to belong to an optional
057: * content group directly, but rather to an optional content membership dictionary
058: * represented by this class.
059: *
060: * @author Paulo Soares (psoares@consiste.pt)
061: */
062: public class PdfLayerMembership extends PdfDictionary implements PdfOCG {
063:
064: /**
065: * Visible only if all of the entries are <B>ON</B>.
066: */
067: public static final PdfName ALLON = new PdfName("AllOn");
068: /**
069: * Visible if any of the entries are <B>ON</B>.
070: */
071: public static final PdfName ANYON = new PdfName("AnyOn");
072: /**
073: * Visible if any of the entries are <B>OFF</B>.
074: */
075: public static final PdfName ANYOFF = new PdfName("AnyOff");
076: /**
077: * Visible only if all of the entries are <B>OFF</B>.
078: */
079: public static final PdfName ALLOFF = new PdfName("AllOff");
080:
081: PdfIndirectReference ref;
082: PdfArray members = new PdfArray();
083: HashSet layers = new HashSet();
084:
085: /**
086: * Creates a new, empty, membership layer.
087: * @param writer the writer
088: */
089: public PdfLayerMembership(PdfWriter writer) {
090: super (PdfName.OCMD);
091: put(PdfName.OCGS, members);
092: ref = writer.getPdfIndirectReference();
093: }
094:
095: /**
096: * Gets the <CODE>PdfIndirectReference</CODE> that represents this membership layer.
097: * @return the <CODE>PdfIndirectReference</CODE> that represents this layer
098: */
099: 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 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: }
|