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
|
<!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:58 EDT 2006 -->
<TITLE>
PDFHighlighter (PDFBox-0.7.3 API)
</TITLE>
<META NAME="keywords" CONTENT="org.pdfbox.util.PDFHighlighter class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="PDFHighlighter (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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PDFHighlighter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/pdfbox/util/Matrix.html" title="class in org.pdfbox.util"><B>PREV CLASS</B></A>
<A HREF="../../../org/pdfbox/util/PDFMergerUtility.html" title="class in org.pdfbox.util"><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>
<A HREF="PDFHighlighter.html" target="_top"><B>NO FRAMES</B></A>
<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: NESTED | <A HREF="#fields_inherited_from_class_org.pdfbox.util.PDFTextStripper">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.util</FONT>
<BR>
Class PDFHighlighter</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/util/PDFStreamEngine.html" title="class in org.pdfbox.util">org.pdfbox.util.PDFStreamEngine</A>
<IMG SRC="../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../org/pdfbox/util/PDFTextStripper.html" title="class in org.pdfbox.util">org.pdfbox.util.PDFTextStripper</A>
<IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>org.pdfbox.util.PDFHighlighter</B>
</PRE>
<HR>
<DL>
<DT>public class <B>PDFHighlighter</B><DT>extends <A HREF="../../../org/pdfbox/util/PDFTextStripper.html" title="class in org.pdfbox.util">PDFTextStripper</A></DL>
<P>
Highlighting of words in a PDF document with an XML file.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.7 $</DD>
<DT><B>Author:</B></DT>
<DD>slagraulet (slagraulet@cardiweb.com), <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a></DD>
<DT><B>See Also:</B><DD><a href="http://partners.adobe.com/public/developer/en/pdf/HighlightFileFormat.pdf">
Adobe Highlight File Format</a></DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_org.pdfbox.util.PDFTextStripper"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Fields inherited from class org.pdfbox.util.<A HREF="../../../org/pdfbox/util/PDFTextStripper.html" title="class in org.pdfbox.util">PDFTextStripper</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../org/pdfbox/util/PDFTextStripper.html#charactersByArticle">charactersByArticle</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#output">output</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== 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><CODE><B><A HREF="../../../org/pdfbox/util/PDFHighlighter.html#PDFHighlighter()">PDFHighlighter</A></B>()</CODE>
<BR>
Default constructor.</TD>
</TR>
</TABLE>
<!-- ========== 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>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/util/PDFHighlighter.html#endPage(org.pdfbox.pdmodel.PDPage)">endPage</A></B>(<A HREF="../../../org/pdfbox/pdmodel/PDPage.html" title="class in org.pdfbox.pdmodel">PDPage</A> pdPage)</CODE>
<BR>
End a page. Default implementation is to do nothing. Subclasses
may provide additional information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/util/PDFHighlighter.html#generateXMLHighlight(org.pdfbox.pdmodel.PDDocument, java.lang.String[], java.io.Writer)">generateXMLHighlight</A></B>(<A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> pdDocument,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] sWords,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Writer.html" title="class or interface in java.io">Writer</A> xmlOutput)</CODE>
<BR>
Generate an XML highlight string based on the PDF.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/util/PDFHighlighter.html#generateXMLHighlight(org.pdfbox.pdmodel.PDDocument, java.lang.String, java.io.Writer)">generateXMLHighlight</A></B>(<A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> pdDocument,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> highlightWord,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Writer.html" title="class or interface in java.io">Writer</A> xmlOutput)</CODE>
<BR>
Generate an XML highlight string based on the PDF.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/util/PDFHighlighter.html#main(java.lang.String[])">main</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] args)</CODE>
<BR>
Command line application.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.pdfbox.util.PDFTextStripper"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.pdfbox.util.<A HREF="../../../org/pdfbox/util/PDFTextStripper.html" title="class in org.pdfbox.util">PDFTextStripper</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../org/pdfbox/util/PDFTextStripper.html#endDocument(org.pdfbox.pdmodel.PDDocument)">endDocument</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#endParagraph()">endParagraph</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#flushText()">flushText</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getCharactersByArticle()">getCharactersByArticle</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getCurrentPageNo()">getCurrentPageNo</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getEndBookmark()">getEndBookmark</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getEndPage()">getEndPage</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getLineSeparator()">getLineSeparator</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getOutput()">getOutput</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getPageSeparator()">getPageSeparator</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getStartBookmark()">getStartBookmark</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getStartPage()">getStartPage</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getText(org.pdfbox.cos.COSDocument)">getText</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getText(org.pdfbox.pdmodel.PDDocument)">getText</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#getWordSeparator()">getWordSeparator</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#processPage(org.pdfbox.pdmodel.PDPage, org.pdfbox.cos.COSStream)">processPage</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#processPages(java.util.List)">processPages</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#setEndBookmark(org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">setEndBookmark</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#setEndPage(int)">setEndPage</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#setLineSeparator(java.lang.String)">setLineSeparator</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#setPageSeparator(java.lang.String)">setPageSeparator</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#setShouldSeparateByBeads(boolean)">setShouldSeparateByBeads</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#setSortByPosition(boolean)">setSortByPosition</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#setStartBookmark(org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">setStartBookmark</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#setStartPage(int)">setStartPage</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#setSuppressDuplicateOverlappingText(boolean)">setSuppressDuplicateOverlappingText</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#setWordSeparator(java.lang.String)">setWordSeparator</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#shouldSeparateByBeads()">shouldSeparateByBeads</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#shouldSortByPosition()">shouldSortByPosition</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#shouldSuppressDuplicateOverlappingText()">shouldSuppressDuplicateOverlappingText</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#showCharacter(org.pdfbox.util.TextPosition)">showCharacter</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#startDocument(org.pdfbox.pdmodel.PDDocument)">startDocument</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#startPage(org.pdfbox.pdmodel.PDPage)">startPage</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#startParagraph()">startParagraph</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#writeCharacters(org.pdfbox.util.TextPosition)">writeCharacters</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#writeText(org.pdfbox.cos.COSDocument, java.io.Writer)">writeText</A>, <A HREF="../../../org/pdfbox/util/PDFTextStripper.html#writeText(org.pdfbox.pdmodel.PDDocument, java.io.Writer)">writeText</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.pdfbox.util.PDFStreamEngine"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.pdfbox.util.<A HREF="../../../org/pdfbox/util/PDFStreamEngine.html" title="class in org.pdfbox.util">PDFStreamEngine</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#getColorSpaces()">getColorSpaces</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#getCurrentPage()">getCurrentPage</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#getFonts()">getFonts</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#getGraphicsStack()">getGraphicsStack</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#getGraphicsState()">getGraphicsState</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#getGraphicsStates()">getGraphicsStates</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#getResources()">getResources</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#getTextLineMatrix()">getTextLineMatrix</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#getTextMatrix()">getTextMatrix</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#getXObjects()">getXObjects</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#processOperator(org.pdfbox.util.PDFOperator, java.util.List)">processOperator</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#processOperator(java.lang.String, java.util.List)">processOperator</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#processStream(org.pdfbox.pdmodel.PDPage, org.pdfbox.pdmodel.PDResources, org.pdfbox.cos.COSStream)">processStream</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#processSubStream(org.pdfbox.pdmodel.PDPage, org.pdfbox.pdmodel.PDResources, org.pdfbox.cos.COSStream)">processSubStream</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#registerOperatorProcessor(java.lang.String, org.pdfbox.util.operator.OperatorProcessor)">registerOperatorProcessor</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#resetEngine()">resetEngine</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#setColorSpaces(java.util.Map)">setColorSpaces</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#setFonts(java.util.Map)">setFonts</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#setGraphicsStack(java.util.Stack)">setGraphicsStack</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#setGraphicsState(org.pdfbox.pdmodel.graphics.PDGraphicsState)">setGraphicsState</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#setGraphicsStates(java.util.Map)">setGraphicsStates</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#setTextLineMatrix(org.pdfbox.util.Matrix)">setTextLineMatrix</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#setTextMatrix(org.pdfbox.util.Matrix)">setTextMatrix</A>, <A HREF="../../../org/pdfbox/util/PDFStreamEngine.html#showString(byte[])">showString</A></CODE></TD>
</TR>
</TABLE>
<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>
<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="PDFHighlighter()"><!-- --></A><H3>
PDFHighlighter</H3>
<PRE>
public <B>PDFHighlighter</B>()
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Default constructor.
<P>
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error constructing this class.</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="generateXMLHighlight(org.pdfbox.pdmodel.PDDocument, java.lang.String, java.io.Writer)"><!-- --></A><H3>
generateXMLHighlight</H3>
<PRE>
public void <B>generateXMLHighlight</B>(<A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> pdDocument,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> highlightWord,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Writer.html" title="class or interface in java.io">Writer</A> xmlOutput)
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Generate an XML highlight string based on the PDF.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pdDocument</CODE> - The PDF to find words in.<DD><CODE>highlightWord</CODE> - The word to search for.<DD><CODE>xmlOutput</CODE> - The resulting output xml file.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error reading from the PDF, or writing to the XML.</DL>
</DD>
</DL>
<HR>
<A NAME="generateXMLHighlight(org.pdfbox.pdmodel.PDDocument, java.lang.String[], java.io.Writer)"><!-- --></A><H3>
generateXMLHighlight</H3>
<PRE>
public void <B>generateXMLHighlight</B>(<A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> pdDocument,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] sWords,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Writer.html" title="class or interface in java.io">Writer</A> xmlOutput)
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Generate an XML highlight string based on the PDF.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pdDocument</CODE> - The PDF to find words in.<DD><CODE>sWords</CODE> - The words to search for.<DD><CODE>xmlOutput</CODE> - The resulting output xml file.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error reading from the PDF, or writing to the XML.</DL>
</DD>
</DL>
<HR>
<A NAME="endPage(org.pdfbox.pdmodel.PDPage)"><!-- --></A><H3>
endPage</H3>
<PRE>
protected void <B>endPage</B>(<A HREF="../../../org/pdfbox/pdmodel/PDPage.html" title="class in org.pdfbox.pdmodel">PDPage</A> pdPage)
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>End a page. Default implementation is to do nothing. Subclasses
may provide additional information.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/pdfbox/util/PDFTextStripper.html#endPage(org.pdfbox.pdmodel.PDPage)">endPage</A></CODE> in class <CODE><A HREF="../../../org/pdfbox/util/PDFTextStripper.html" title="class in org.pdfbox.util">PDFTextStripper</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pdPage</CODE> - The page we are about to process.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is any error writing to the stream.</DL>
</DD>
</DL>
<HR>
<A NAME="main(java.lang.String[])"><!-- --></A><H3>
main</H3>
<PRE>
public static void <B>main</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] args)
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Command line application.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>args</CODE> - The command line arguments to the application.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error generating the highlight file.</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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PDFHighlighter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/pdfbox/util/Matrix.html" title="class in org.pdfbox.util"><B>PREV CLASS</B></A>
<A HREF="../../../org/pdfbox/util/PDFMergerUtility.html" title="class in org.pdfbox.util"><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>
<A HREF="PDFHighlighter.html" target="_top"><B>NO FRAMES</B></A>
<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: NESTED | <A HREF="#fields_inherited_from_class_org.pdfbox.util.PDFTextStripper">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|
