1 /* 2 * Copyright 2003 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 package com.lowagie.text.pdf; 48 49 /** The graphic state dictionary. 50 * 51 * @author Paulo Soares (psoares@consiste.pt) 52 */ 53 public class PdfGState extends PdfDictionary { 54 /** A possible blend mode */ 55 public static final PdfName BM_NORMAL = new PdfName("Normal"); 56 /** A possible blend mode */ 57 public static final PdfName BM_COMPATIBLE = new PdfName("Compatible"); 58 /** A possible blend mode */ 59 public static final PdfName BM_MULTIPLY = new PdfName("Multiply"); 60 /** A possible blend mode */ 61 public static final PdfName BM_SCREEN = new PdfName("Screen"); 62 /** A possible blend mode */ 63 public static final PdfName BM_OVERLAY = new PdfName("Overlay"); 64 /** A possible blend mode */ 65 public static final PdfName BM_DARKEN = new PdfName("Darken"); 66 /** A possible blend mode */ 67 public static final PdfName BM_LIGHTEN = new PdfName("Lighten"); 68 /** A possible blend mode */ 69 public static final PdfName BM_COLORDODGE = new PdfName("ColorDodge"); 70 /** A possible blend mode */ 71 public static final PdfName BM_COLORBURN = new PdfName("ColorBurn"); 72 /** A possible blend mode */ 73 public static final PdfName BM_HARDLIGHT = new PdfName("HardLight"); 74 /** A possible blend mode */ 75 public static final PdfName BM_SOFTLIGHT = new PdfName("SoftLight"); 76 /** A possible blend mode */ 77 public static final PdfName BM_DIFFERENCE = new PdfName("Difference"); 78 /** A possible blend mode */ 79 public static final PdfName BM_EXCLUSION = new PdfName("Exclusion"); 80 81 /** 82 * Sets the flag whether to apply overprint for stroking. 83 * @param ov 84 */ setOverPrintStroking(boolean ov)85 public void setOverPrintStroking(boolean ov) { 86 put(PdfName.OP, ov ? PdfBoolean.PDFTRUE : PdfBoolean.PDFFALSE); 87 } 88 89 /** 90 * Sets the flag whether to apply overprint for non stroking painting operations. 91 * @param ov 92 */ setOverPrintNonStroking(boolean ov)93 public void setOverPrintNonStroking(boolean ov) { 94 put(PdfName.op, ov ? PdfBoolean.PDFTRUE : PdfBoolean.PDFFALSE); 95 } 96 97 /** 98 * Sets the flag whether to toggle knockout behavior for overprinted objects. 99 * @param ov - accepts 0 or 1 100 */ setOverPrintMode(int ov)101 public void setOverPrintMode(int ov) { 102 put(PdfName.OPM, new PdfNumber(ov==0 ? 0 : 1)); 103 } 104 105 /** 106 * Sets the current stroking alpha constant, specifying the constant shape or 107 * constant opacity value to be used for stroking operations in the transparent 108 * imaging model. 109 * @param n 110 */ setStrokeOpacity(float n)111 public void setStrokeOpacity(float n) { 112 put(PdfName.CA, new PdfNumber(n)); 113 } 114 115 /** 116 * Sets the current stroking alpha constant, specifying the constant shape or 117 * constant opacity value to be used for nonstroking operations in the transparent 118 * imaging model. 119 * @param n 120 */ setFillOpacity(float n)121 public void setFillOpacity(float n) { 122 put(PdfName.ca, new PdfNumber(n)); 123 } 124 125 /** 126 * The alpha source flag specifying whether the current soft mask 127 * and alpha constant are to be interpreted as shape values (true) 128 * or opacity values (false). 129 * @param v 130 */ setAlphaIsShape(boolean v)131 public void setAlphaIsShape(boolean v) { 132 put(PdfName.AIS, v ? PdfBoolean.PDFTRUE : PdfBoolean.PDFFALSE); 133 } 134 135 /** 136 * Determines the behavior of overlapping glyphs within a text object 137 * in the transparent imaging model. 138 * @param v 139 */ setTextKnockout(boolean v)140 public void setTextKnockout(boolean v) { 141 put(PdfName.TK, v ? PdfBoolean.PDFTRUE : PdfBoolean.PDFFALSE); 142 } 143 144 /** 145 * The current blend mode to be used in the transparent imaging model. 146 * @param bm 147 */ setBlendMode(PdfName bm)148 public void setBlendMode(PdfName bm) { 149 put(PdfName.BM, bm); 150 } 151 152 } 153