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.interactive.action;
031:
032: import org.pdfbox.cos.COSBase;
033: import org.pdfbox.cos.COSDictionary;
034:
035: import org.pdfbox.pdmodel.common.COSObjectable;
036: import org.pdfbox.pdmodel.interactive.action.type.PDAction;
037:
038: /**
039: * This class represents a form field's dictionary of actions
040: * that occur due to events.
041: *
042: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
043: * @author Panagiotis Toumasis (ptoumasis@mail.gr)
044: * @version $Revision: 1.2 $
045: */
046: public class PDFormFieldAdditionalActions implements COSObjectable {
047: private COSDictionary actions;
048:
049: /**
050: * Default constructor.
051: */
052: public PDFormFieldAdditionalActions() {
053: actions = new COSDictionary();
054: }
055:
056: /**
057: * Constructor.
058: *
059: * @param a The action dictionary.
060: */
061: public PDFormFieldAdditionalActions(COSDictionary a) {
062: actions = a;
063: }
064:
065: /**
066: * Convert this standard java object to a COS object.
067: *
068: * @return The cos object that matches this Java object.
069: */
070: public COSBase getCOSObject() {
071: return actions;
072: }
073:
074: /**
075: * Convert this standard java object to a COS object.
076: *
077: * @return The cos object that matches this Java object.
078: */
079: public COSDictionary getCOSDictionary() {
080: return actions;
081: }
082:
083: /**
084: * This will get a JavaScript action to be performed when the user
085: * types a keystroke into a text field or combo box or modifies the
086: * selection in a scrollable list box. This allows the keystroke to
087: * be checked for validity and rejected or modified.
088: *
089: * @return The K entry of form field's additional actions dictionary.
090: */
091: public PDAction getK() {
092: COSDictionary k = (COSDictionary) actions
093: .getDictionaryObject("K");
094: PDAction retval = null;
095: if (k != null) {
096: retval = PDActionFactory.createAction(k);
097: }
098: return retval;
099: }
100:
101: /**
102: * This will set a JavaScript action to be performed when the user
103: * types a keystroke into a text field or combo box or modifies the
104: * selection in a scrollable list box. This allows the keystroke to
105: * be checked for validity and rejected or modified.
106: *
107: * @param k The action to be performed.
108: */
109: public void setK(PDAction k) {
110: actions.setItem("K", k);
111: }
112:
113: /**
114: * This will get a JavaScript action to be performed before
115: * the field is formatted to display its current value. This
116: * allows the field's value to be modified before formatting.
117: *
118: * @return The F entry of form field's additional actions dictionary.
119: */
120: public PDAction getF() {
121: COSDictionary f = (COSDictionary) actions
122: .getDictionaryObject("F");
123: PDAction retval = null;
124: if (f != null) {
125: retval = PDActionFactory.createAction(f);
126: }
127: return retval;
128: }
129:
130: /**
131: * This will set a JavaScript action to be performed before
132: * the field is formatted to display its current value. This
133: * allows the field's value to be modified before formatting.
134: *
135: * @param f The action to be performed.
136: */
137: public void setF(PDAction f) {
138: actions.setItem("F", f);
139: }
140:
141: /**
142: * This will get a JavaScript action to be performed
143: * when the field's value is changed. This allows the
144: * new value to be checked for validity.
145: * The name V stands for "validate".
146: *
147: * @return The V entry of form field's additional actions dictionary.
148: */
149: public PDAction getV() {
150: COSDictionary v = (COSDictionary) actions
151: .getDictionaryObject("V");
152: PDAction retval = null;
153: if (v != null) {
154: retval = PDActionFactory.createAction(v);
155: }
156: return retval;
157: }
158:
159: /**
160: * This will set a JavaScript action to be performed
161: * when the field's value is changed. This allows the
162: * new value to be checked for validity.
163: * The name V stands for "validate".
164: *
165: * @param v The action to be performed.
166: */
167: public void setV(PDAction v) {
168: actions.setItem("V", v);
169: }
170:
171: /**
172: * This will get a JavaScript action to be performed in order to recalculate
173: * the value of this field when that of another field changes. The order in which
174: * the document's fields are recalculated is defined by the CO entry in the
175: * interactive form dictionary.
176: * The name C stands for "calculate".
177: *
178: * @return The C entry of form field's additional actions dictionary.
179: */
180: public PDAction getC() {
181: COSDictionary c = (COSDictionary) actions
182: .getDictionaryObject("C");
183: PDAction retval = null;
184: if (c != null) {
185: retval = PDActionFactory.createAction(c);
186: }
187: return retval;
188: }
189:
190: /**
191: * This will set a JavaScript action to be performed in order to recalculate
192: * the value of this field when that of another field changes. The order in which
193: * the document's fields are recalculated is defined by the CO entry in the
194: * interactive form dictionary.
195: * The name C stands for "calculate".
196: *
197: * @param c The action to be performed.
198: */
199: public void setC(PDAction c) {
200: actions.setItem("C", c);
201: }
202: }
|