001: /*
002: * Copyright (c) 2007, intarsys consulting GmbH
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * - Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: *
010: * - 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: *
014: * - Neither the name of intarsys nor the names of its contributors may be used
015: * to endorse or promote products derived from this software without specific
016: * prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
020: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
021: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
022: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
024: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
025: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
026: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
027: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
028: * POSSIBILITY OF SUCH DAMAGE.
029: */
030: package de.intarsys.pdf.pd;
031:
032: import java.util.ArrayList;
033: import java.util.List;
034: import de.intarsys.pdf.cos.COSArray;
035: import de.intarsys.pdf.cos.COSBasedObject;
036: import de.intarsys.pdf.cos.COSInteger;
037: import de.intarsys.pdf.cos.COSName;
038: import de.intarsys.pdf.cos.COSObject;
039:
040: /**
041: * The ResetForm action.
042: * <p>
043: * When executed the action clears all field in an AcroForm.
044: *
045: */
046: public class PDActionResetForm extends PDAction {
047: /**
048: * The meta class implementation
049: */
050: static public class MetaClass extends PDAction.MetaClass {
051: protected MetaClass(Class instanceClass) {
052: super (instanceClass);
053: }
054:
055: /*
056: * (non-Javadoc)
057: *
058: * @see de.intarsys.pdf.cos.COSBasedObject.MetaClass#doDetermineClass(de.intarsys.pdf.cos.COSObject)
059: */
060: protected COSBasedObject.MetaClass doDetermineClass(
061: COSObject object) {
062: return PDActionResetForm.META;
063: }
064: }
065:
066: /** The meta class instance */
067: static public final MetaClass META = new MetaClass(MetaClass.class
068: .getDeclaringClass());
069:
070: public static final COSName CN_ActionType_ResetForm = COSName
071: .constant("ResetForm");
072:
073: public static final COSName DK_Fields = COSName.constant("Fields");
074:
075: public static final COSName DK_Flags = COSName.constant("Flags");
076:
077: static public PDActionResetForm createNew() {
078: PDActionResetForm result = (PDActionResetForm) PDActionResetForm.META
079: .createNew();
080: return result;
081: }
082:
083: protected PDActionResetForm(COSObject object) {
084: super (object);
085: }
086:
087: public COSName cosGetExpectedActionType() {
088: return CN_ActionType_ResetForm;
089: }
090:
091: protected int basicGetFlags() {
092: // inheritance doesn't make any sense, so we ignore it right now
093: return getFieldInt(DK_Flags, 0);
094: }
095:
096: protected void basicSetFlags(int newFlags) {
097: if (newFlags != 0) { // default
098: cosSetField(DK_Flags, COSInteger.create(newFlags));
099: } else {
100: cosRemoveField(DK_Flags);
101: }
102: }
103:
104: public boolean isExclude() {
105: return (basicGetFlags() & 1) != 0;
106: }
107:
108: /**
109: * A list of field names (plain Java String) to be resetted or null.
110: *
111: * @return A list of field names (plain Java String) to be resetted or null.
112: */
113: public List getFields() {
114: COSArray cosFields = cosGetField(DK_Fields).asArray();
115: if (cosFields == null) {
116: return null;
117: }
118: List fields = new ArrayList();
119: for (int i = 0; i < cosFields.size(); i++) {
120: COSObject cosField = cosFields.get(i);
121: fields.add(cosField.stringValue());
122: }
123: return fields;
124: }
125: }
|