com.lowagie.text.pdf.PdfLayerMembership Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of itext2 Show documentation
Show all versions of itext2 Show documentation
Itext is a java library to create and manipulate PDFs.
This is a fork of version 2.1.7 the last MPL/LGPL version.
It's focused basically on mantain compatibility with newer bouncycastle releases and small bugfixes.
/*
* Copyright 2004 by Paulo Soares.
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text.pdf;
import java.util.Collection;
import java.util.HashSet;
/**
* Content typically belongs to a single optional content group,
* and is visible when the group is ON and invisible when it is OFF. To express more
* complex visibility policies, content should not declare itself to belong to an optional
* content group directly, but rather to an optional content membership dictionary
* represented by this class.
*
* @author Paulo Soares ([email protected])
*/
public class PdfLayerMembership extends PdfDictionary implements PdfOCG {
/**
* Visible only if all of the entries are ON.
*/
public static final PdfName ALLON = new PdfName("AllOn");
/**
* Visible if any of the entries are ON.
*/
public static final PdfName ANYON = new PdfName("AnyOn");
/**
* Visible if any of the entries are OFF.
*/
public static final PdfName ANYOFF = new PdfName("AnyOff");
/**
* Visible only if all of the entries are OFF.
*/
public static final PdfName ALLOFF = new PdfName("AllOff");
PdfIndirectReference ref;
PdfArray members = new PdfArray();
HashSet layers = new HashSet();
/**
* Creates a new, empty, membership layer.
* @param writer the writer
*/
public PdfLayerMembership(PdfWriter writer) {
super(PdfName.OCMD);
put(PdfName.OCGS, members);
ref = writer.getPdfIndirectReference();
}
/**
* Gets the PdfIndirectReference that represents this membership layer.
* @return the PdfIndirectReference that represents this layer
*/
public PdfIndirectReference getRef() {
return ref;
}
/**
* Adds a new member to the layer.
* @param layer the new member to the layer
*/
public void addMember(PdfLayer layer) {
if (!layers.contains(layer)) {
members.add(layer.getRef());
layers.add(layer);
}
}
/**
* Gets the member layers.
* @return the member layers
*/
public Collection getLayers() {
return layers;
}
/**
* Sets the visibility policy for content belonging to this
* membership dictionary. Possible values are ALLON, ANYON, ANYOFF and ALLOFF.
* The default value is ANYON.
* @param type the visibility policy
*/
public void setVisibilityPolicy(PdfName type) {
put(PdfName.P, type);
}
/**
* Gets the dictionary representing the membership layer. It just returns this.
* @return the dictionary representing the layer
*/
public PdfObject getPdfObject() {
return this;
}
}