001/*
002 * $Id: PdfDashPattern.java 4784 2011-03-15 08:33:00Z blowagie $
003 *
004 * This file is part of the iText (R) project.
005 * Copyright (c) 1998-2011 1T3XT BVBA
006 * Authors: Bruno Lowagie, Paulo Soares, et al.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU Affero General Public License version 3
010 * as published by the Free Software Foundation with the addition of the
011 * following permission added to Section 15 as permitted in Section 7(a):
012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
014 *
015 * This program is distributed in the hope that it will be useful, but
016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
017 * or FITNESS FOR A PARTICULAR PURPOSE.
018 * See the GNU Affero General Public License for more details.
019 * You should have received a copy of the GNU Affero General Public License
020 * along with this program; if not, see http://www.gnu.org/licenses or write to
021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
022 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
023 * http://itextpdf.com/terms-of-use/
024 *
025 * The interactive user interfaces in modified source and object code versions
026 * of this program must display Appropriate Legal Notices, as required under
027 * Section 5 of the GNU Affero General Public License.
028 *
029 * In accordance with Section 7(b) of the GNU Affero General Public License,
030 * a covered work must retain the producer line in every PDF that is created
031 * or manipulated using iText.
032 *
033 * You can be released from the requirements of the license by purchasing
034 * a commercial license. Buying such a license is mandatory as soon as you
035 * develop commercial activities involving the iText software without
036 * disclosing the source code of your own applications.
037 * These activities include: offering paid services to customers as an ASP,
038 * serving PDFs on the fly in a web application, shipping iText with a closed
039 * source product.
040 *
041 * For more information, please contact iText Software Corp. at this
042 * address: sales@itextpdf.com
043 */
044package com.itextpdf.text.pdf;
045
046import java.io.IOException;
047import java.io.OutputStream;
048
049/**
050 * A <CODE>PdfDashPattern</CODE> defines a dash pattern as described in
051 * the PDF Reference Manual version 1.3 p 325 (section 8.4.3).
052 *
053 * @see         PdfArray
054 */
055
056public class PdfDashPattern extends PdfArray {
057    
058    // membervariables
059    
060/** This is the length of a dash. */
061    private float dash = -1;
062    
063/** This is the length of a gap. */
064    private float gap = -1;
065    
066/** This is the phase. */
067    private float phase = -1;
068    
069    // constructors
070    
071/**
072 * Constructs a new <CODE>PdfDashPattern</CODE>.
073 */
074    
075    public PdfDashPattern() {
076        super();
077    }
078    
079/**
080 * Constructs a new <CODE>PdfDashPattern</CODE>.
081 */
082    
083    public PdfDashPattern(float dash) {
084        super(new PdfNumber(dash));
085        this.dash = dash;
086    }
087    
088/**
089 * Constructs a new <CODE>PdfDashPattern</CODE>.
090 */
091    
092    public PdfDashPattern(float dash, float gap) {
093        super(new PdfNumber(dash));
094        add(new PdfNumber(gap));
095        this.dash = dash;
096        this.gap = gap;
097    }
098    
099/**
100 * Constructs a new <CODE>PdfDashPattern</CODE>.
101 */
102    
103    public PdfDashPattern(float dash, float gap, float phase) {
104        super(new PdfNumber(dash));
105        add(new PdfNumber(gap));
106        this.dash = dash;
107        this.gap = gap;
108        this.phase = phase;
109    }
110    
111    public void add(float n) {
112        add(new PdfNumber(n));
113    }
114    
115/**
116 * Returns the PDF representation of this <CODE>PdfArray</CODE>.
117 */
118    
119    public void toPdf(PdfWriter writer, OutputStream os) throws IOException {
120        os.write('[');
121
122        if (dash >= 0) {
123            new PdfNumber(dash).toPdf(writer, os);
124            if (gap >= 0) {
125                os.write(' ');
126                new PdfNumber(gap).toPdf(writer, os);
127            }
128        }
129        os.write(']');
130        if (phase >=0) {
131            os.write(' ');
132            new PdfNumber(phase).toPdf(writer, os);
133        }
134    }
135}