001: /**
002: * Copyright (c) 2004, www.pdfbox.org
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * 1. Redistributions of source code must retain the above copyright notice,
009: * this list of conditions and the following disclaimer.
010: * 2. Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: * 3. Neither the name of pdfbox; nor the names of its
014: * contributors may be used to endorse or promote products derived from this
015: * software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
018: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
019: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
020: * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
021: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
022: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
023: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
024: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
026: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027: *
028: * http://www.pdfbox.org
029: *
030: */package org.pdfbox.pdmodel.common;
031:
032: import org.pdfbox.cos.COSArray;
033: import org.pdfbox.cos.COSBase;
034: import org.pdfbox.cos.COSFloat;
035: import org.pdfbox.cos.COSNumber;
036:
037: /**
038: * This class will be used to signify a range. a(min) <= a* <= a(max)
039: *
040: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
041: * @version $Revision: 1.4 $
042: */
043: public class PDRange implements COSObjectable {
044: private COSArray rangeArray;
045: private int startingIndex;
046:
047: /**
048: * Constructor with an initial range of 0..1.
049: */
050: public PDRange() {
051: rangeArray = new COSArray();
052: rangeArray.add(new COSFloat(0.0f));
053: rangeArray.add(new COSFloat(1.0f));
054: startingIndex = 0;
055: }
056:
057: /**
058: * Constructor assumes a starting index of 0.
059: *
060: * @param range The array that describes the range.
061: */
062: public PDRange(COSArray range) {
063: rangeArray = range;
064: }
065:
066: /**
067: * Constructor with an index into an array. Because some arrays specify
068: * multiple ranges ie [ 0,1, 0,2, 2,3 ] It is convenient for this
069: * class to take an index into an array. So if you want this range to
070: * represent 0,2 in the above example then you would say <code>new PDRange( array, 1 )</code>.
071: *
072: * @param range The array that describes the index
073: * @param index The range index into the array for the start of the range.
074: */
075: public PDRange(COSArray range, int index) {
076: rangeArray = range;
077: startingIndex = index;
078: }
079:
080: /**
081: * Convert this standard java object to a COS object.
082: *
083: * @return The cos object that matches this Java object.
084: */
085: public COSBase getCOSObject() {
086: return rangeArray;
087: }
088:
089: /**
090: * This will get the underlying array value.
091: *
092: * @return The cos object that this object wraps.
093: */
094: public COSArray getCOSArray() {
095: return rangeArray;
096: }
097:
098: /**
099: * This will get the minimum value of the range.
100: *
101: * @return The min value.
102: */
103: public float getMin() {
104: COSNumber min = (COSNumber) rangeArray
105: .getObject(startingIndex * 2);
106: return min.floatValue();
107: }
108:
109: /**
110: * This will set the minimum value for the range.
111: *
112: * @param min The new minimum for the range.
113: */
114: public void setMin(float min) {
115: rangeArray.set(startingIndex * 2, new COSFloat(min));
116: }
117:
118: /**
119: * This will get the maximum value of the range.
120: *
121: * @return The max value.
122: */
123: public float getMax() {
124: COSNumber max = (COSNumber) rangeArray
125: .getObject(startingIndex * 2 + 1);
126: return max.floatValue();
127: }
128:
129: /**
130: * This will set the maximum value for the range.
131: *
132: * @param max The new maximum for the range.
133: */
134: public void setMax(float max) {
135: rangeArray.set(startingIndex * 2 + 1, new COSFloat(max));
136: }
137: }
|