File: PDDictionaryFunction.html

package info (click to toggle)
libpdfbox-java 1%3A0.7.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 27,316 kB
  • ctags: 18,061
  • sloc: java: 38,032; xml: 2,650; sh: 48; jsp: 27; makefile: 12
file content (500 lines) | stat: -rw-r--r-- 25,331 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.4.2_07) on Thu Oct 12 12:19:56 EDT 2006 -->
<TITLE>
PDDictionaryFunction (PDFBox-0.7.3 API)
</TITLE>

<META NAME="keywords" CONTENT="org.pdfbox.pdmodel.common.function.PDDictionaryFunction class">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    parent.document.title="PDDictionaryFunction (PDFBox-0.7.3 API)";
}
</SCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PDDictionaryFunction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PDDictionaryFunction.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.pdfbox.pdmodel.common.function</FONT>
<BR>
Class PDDictionaryFunction</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function">org.pdfbox.pdmodel.common.function.PDFunction</A>
      <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.pdfbox.pdmodel.common.function.PDDictionaryFunction</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.pdfbox.pdmodel.common">COSObjectable</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunctionType2.html" title="class in org.pdfbox.pdmodel.common.function">PDFunctionType2</A>, <A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunctionType3.html" title="class in org.pdfbox.pdmodel.common.function">PDFunctionType3</A></DD>
</DL>
<HR>
<DL>
<DT>public abstract class <B>PDDictionaryFunction</B><DT>extends <A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function">PDFunction</A></DL>

<P>
This class represents a function in a PDF document.
<P>

<P>
<DL>
<DT><B>Version:</B></DT>
  <DD>$Revision: 1.3 $</DD>
<DT><B>Author:</B></DT>
  <DD><a href="mailto:ben@benlitchfield.com">Ben Litchfield</a></DD>
</DL>
<HR>

<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->


<!-- =========== FIELD SUMMARY =========== -->


<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDDictionaryFunction.html#PDDictionaryFunction(org.pdfbox.cos.COSDictionary)">PDDictionaryFunction</A></B>(<A HREF="../../../../../org/pdfbox/cos/COSDictionary.html" title="class in org.pdfbox.cos">COSDictionary</A>&nbsp;functionDictionary)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDDictionaryFunction.html#PDDictionaryFunction(int)">PDDictionaryFunction</A></B>(int&nbsp;functionType)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor to create a new blank function, should only be called by 
 subclasses.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/pdfbox/cos/COSDictionary.html" title="class in org.pdfbox.cos">COSDictionary</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDDictionaryFunction.html#getCOSDictionary()">getCOSDictionary</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the underlying cos dictionary.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/pdfbox/cos/COSBase.html" title="class in org.pdfbox.cos">COSBase</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDDictionaryFunction.html#getCOSObject()">getCOSObject</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert this standard java object to a COS object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/pdfbox/pdmodel/common/PDRange.html" title="class in org.pdfbox.pdmodel.common">PDRange</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDDictionaryFunction.html#getDomainForInput(int)">getDomainForInput</A></B>(int&nbsp;n)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will get the range for a certain input parameter.  This is will never
 return null.  If it is not present then the range 0 to 0 will
 be returned.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDDictionaryFunction.html#getNumberOfInputParameters()">getNumberOfInputParameters</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will get the number of input parameters that
 have a domain specified.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDDictionaryFunction.html#getNumberOfOutputParameters()">getNumberOfOutputParameters</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will get the number of output parameters that
 have a range specified.  A range for output parameters
 is optional so this may return zero for a function
 that does have output parameters, this will simply return the
 number that have the rnage specified.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/pdfbox/pdmodel/common/PDRange.html" title="class in org.pdfbox.pdmodel.common">PDRange</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDDictionaryFunction.html#getRangeForOutput(int)">getRangeForOutput</A></B>(int&nbsp;n)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will get the range for a certain output parameters.  This is will never
 return null.  If it is not present then the range 0 to 0 will
 be returned.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDDictionaryFunction.html#setDomainForInput(org.pdfbox.pdmodel.common.PDRange, int)">setDomainForInput</A></B>(<A HREF="../../../../../org/pdfbox/pdmodel/common/PDRange.html" title="class in org.pdfbox.pdmodel.common">PDRange</A>&nbsp;range,
                  int&nbsp;n)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will set the domain for the input values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDDictionaryFunction.html#setRangeForOutput(org.pdfbox.pdmodel.common.PDRange, int)">setRangeForOutput</A></B>(<A HREF="../../../../../org/pdfbox/pdmodel/common/PDRange.html" title="class in org.pdfbox.pdmodel.common">PDRange</A>&nbsp;range,
                  int&nbsp;n)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will set the a range for output parameter.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.pdfbox.pdmodel.common.function.PDFunction"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.pdfbox.pdmodel.common.function.<A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function">PDFunction</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html#create(org.pdfbox.cos.COSBase)">create</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="PDDictionaryFunction(int)"><!-- --></A><H3>
PDDictionaryFunction</H3>
<PRE>
protected <B>PDDictionaryFunction</B>(int&nbsp;functionType)</PRE>
<DL>
<DD>Constructor to create a new blank function, should only be called by 
 subclasses.
<P>
<DT><B>Parameters:</B><DD><CODE>functionType</CODE> - An integer describing the function type, only 0,2,3,4
  are defined by the PDF sepc.</DL>
<HR>

<A NAME="PDDictionaryFunction(org.pdfbox.cos.COSDictionary)"><!-- --></A><H3>
PDDictionaryFunction</H3>
<PRE>
public <B>PDDictionaryFunction</B>(<A HREF="../../../../../org/pdfbox/cos/COSDictionary.html" title="class in org.pdfbox.cos">COSDictionary</A>&nbsp;functionDictionary)</PRE>
<DL>
<DD>Constructor.
<P>
<DT><B>Parameters:</B><DD><CODE>functionDictionary</CODE> - The prepopulated function dictionary.</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getCOSObject()"><!-- --></A><H3>
getCOSObject</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/cos/COSBase.html" title="class in org.pdfbox.cos">COSBase</A> <B>getCOSObject</B>()</PRE>
<DL>
<DD>Convert this standard java object to a COS object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The cos object that matches this Java object.</DL>
</DD>
</DL>
<HR>

<A NAME="getCOSDictionary()"><!-- --></A><H3>
getCOSDictionary</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/cos/COSDictionary.html" title="class in org.pdfbox.cos">COSDictionary</A> <B>getCOSDictionary</B>()</PRE>
<DL>
<DD>Get the underlying cos dictionary.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The underlying cos dictionary.</DL>
</DD>
</DL>
<HR>

<A NAME="getNumberOfOutputParameters()"><!-- --></A><H3>
getNumberOfOutputParameters</H3>
<PRE>
public int <B>getNumberOfOutputParameters</B>()</PRE>
<DL>
<DD>This will get the number of output parameters that
 have a range specified.  A range for output parameters
 is optional so this may return zero for a function
 that does have output parameters, this will simply return the
 number that have the rnage specified.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html#getNumberOfOutputParameters()">getNumberOfOutputParameters</A></CODE> in class <CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function">PDFunction</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The number of input parameters that have a range
 specified.</DL>
</DD>
</DL>
<HR>

<A NAME="getRangeForOutput(int)"><!-- --></A><H3>
getRangeForOutput</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/pdmodel/common/PDRange.html" title="class in org.pdfbox.pdmodel.common">PDRange</A> <B>getRangeForOutput</B>(int&nbsp;n)</PRE>
<DL>
<DD>This will get the range for a certain output parameters.  This is will never
 return null.  If it is not present then the range 0 to 0 will
 be returned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html#getRangeForOutput(int)">getRangeForOutput</A></CODE> in class <CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function">PDFunction</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>n</CODE> - The output parameter number to get the range for.
<DT><B>Returns:</B><DD>The range for this component.</DL>
</DD>
</DL>
<HR>

<A NAME="setRangeForOutput(org.pdfbox.pdmodel.common.PDRange, int)"><!-- --></A><H3>
setRangeForOutput</H3>
<PRE>
public void <B>setRangeForOutput</B>(<A HREF="../../../../../org/pdfbox/pdmodel/common/PDRange.html" title="class in org.pdfbox.pdmodel.common">PDRange</A>&nbsp;range,
                              int&nbsp;n)</PRE>
<DL>
<DD>This will set the a range for output parameter.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html#setRangeForOutput(org.pdfbox.pdmodel.common.PDRange, int)">setRangeForOutput</A></CODE> in class <CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function">PDFunction</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>range</CODE> - The new range for the output parameter.<DD><CODE>n</CODE> - The ouput parameter number to set the range for.</DL>
</DD>
</DL>
<HR>

<A NAME="getNumberOfInputParameters()"><!-- --></A><H3>
getNumberOfInputParameters</H3>
<PRE>
public int <B>getNumberOfInputParameters</B>()</PRE>
<DL>
<DD>This will get the number of input parameters that
 have a domain specified.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html#getNumberOfInputParameters()">getNumberOfInputParameters</A></CODE> in class <CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function">PDFunction</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The number of input parameters that have a domain
 specified.</DL>
</DD>
</DL>
<HR>

<A NAME="getDomainForInput(int)"><!-- --></A><H3>
getDomainForInput</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/pdmodel/common/PDRange.html" title="class in org.pdfbox.pdmodel.common">PDRange</A> <B>getDomainForInput</B>(int&nbsp;n)</PRE>
<DL>
<DD>This will get the range for a certain input parameter.  This is will never
 return null.  If it is not present then the range 0 to 0 will
 be returned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html#getDomainForInput(int)">getDomainForInput</A></CODE> in class <CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function">PDFunction</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>n</CODE> - The parameter number to get the domain for.
<DT><B>Returns:</B><DD>The domain range for this component.</DL>
</DD>
</DL>
<HR>

<A NAME="setDomainForInput(org.pdfbox.pdmodel.common.PDRange, int)"><!-- --></A><H3>
setDomainForInput</H3>
<PRE>
public void <B>setDomainForInput</B>(<A HREF="../../../../../org/pdfbox/pdmodel/common/PDRange.html" title="class in org.pdfbox.pdmodel.common">PDRange</A>&nbsp;range,
                              int&nbsp;n)</PRE>
<DL>
<DD>This will set the domain for the input values.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html#setDomainForInput(org.pdfbox.pdmodel.common.PDRange, int)">setDomainForInput</A></CODE> in class <CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function">PDFunction</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>range</CODE> - The new range for the input.<DD><CODE>n</CODE> - The number of the input parameter to set the domain for.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PDDictionaryFunction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../org/pdfbox/pdmodel/common/function/PDFunction.html" title="class in org.pdfbox.pdmodel.common.function"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PDDictionaryFunction.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>