/**
* Copyright (c) 2003-2006, www.pdfbox.org
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of pdfbox; nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://www.pdfbox.org
*
*/
package org.pdfbox.pdmodel.graphics;
import org.pdfbox.cos.COSArray;
import org.pdfbox.cos.COSBase;
import org.pdfbox.cos.COSInteger;
import org.pdfbox.cos.COSNumber;
import org.pdfbox.pdmodel.common.COSArrayList;
import org.pdfbox.pdmodel.common.COSObjectable;
import java.util.List;
/**
* This class represents the line dash pattern for a graphics state. See PDF
* Reference 1.5 section 4.3.2
*
* @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
* @version $Revision: 1.6 $
*/
public class PDLineDashPattern implements COSObjectable
{
private COSArray lineDashPattern = null;
/**
* Creates a blank line dash pattern. With no dashes and a phase of 0.
*/
public PDLineDashPattern()
{
lineDashPattern = new COSArray();
lineDashPattern.add( new COSArray() );
lineDashPattern.add( new COSInteger( 0 ) );
}
/**
* Constructs a line dash pattern from an existing array.
*
* @param ldp The existing line dash pattern.
*/
public PDLineDashPattern( COSArray ldp )
{
lineDashPattern = ldp;
}
/**
* Constructs a line dash pattern from an existing array.
*
* @param ldp The existing line dash pattern.
* @param phase The phase for the line dash pattern.
*/
public PDLineDashPattern( COSArray ldp, int phase )
{
lineDashPattern = new COSArray();
lineDashPattern.add( ldp );
lineDashPattern.add( new COSInteger( phase ) );
}
/**
* {@inheritDoc}
*/
public COSBase getCOSObject()
{
return lineDashPattern;
}
/**
* This will get the line dash pattern phase. The dash phase specifies the
* distance into the dash pattern at which to start the dash.
*
* @return The line dash pattern phase.
*/
public int getPhaseStart()
{
COSNumber phase = (COSNumber)lineDashPattern.get( 1 );
return phase.intValue();
}
/**
* This will set the line dash pattern phase.
*
* @param phase The new line dash patter phase.
*/
public void setPhaseStart( int phase )
{
lineDashPattern.set( 1, new COSInteger( phase ) );
}
/**
* This will return a list of java.lang.Integer objects that represent the line
* dash pattern appearance.
*
* @return The line dash pattern.
*/
public List getDashPattern()
{
COSArray dashPatterns = (COSArray)lineDashPattern.get( 0 );
return COSArrayList.convertIntegerCOSArrayToList( dashPatterns );
}
/**
* Get the line dash pattern as a COS object.
*
* @return The cos array line dash pattern.
*/
public COSArray getCOSDashPattern()
{
return (COSArray)lineDashPattern.get( 0 );
}
/**
* This will replace the existing line dash pattern.
*
* @param dashPattern A list of java.lang.Integer objects.
*/
public void setDashPattern( List dashPattern )
{
lineDashPattern.set( 0, COSArrayList.converterToCOSArray( dashPattern ) );
}
}