## Uses of Class
org.faceless.pdf2.PageExtractor.Text

- Packages that use PageExtractor.Text
  Package | Description
  --- | ---
  org.faceless.pdf2 | Contains the classes used to create a PDF document
  org.faceless.pdf2.viewer2.feature | Contains a list of all the features that are available to the PDFViewer.

- - ### Uses of PageExtractor.Text in org.faceless.pdf2

    Fields in org.faceless.pdf2 with type parameters of type PageExtractor.Text
    Modifier and Type | Field and Description
    --- | ---
    `static Comparator<PageExtractor.Text>` | PageExtractor.`DISPLAYORDER` A Comparator which can be used to sort `PageExtractor.Text` objects into their "display" order - the order which they visibly appear on the page, and the order that is returned by `PageExtractor.getTextInDisplayOrder()`
    `static Comparator<PageExtractor.Text>` | PageExtractor.`NATURALORDER` A Comparator which can be used to sort `PageExtractor.Text` objects into their "natural" order - the order which they occur in the PDF page stream, and the order that is returned by `PageExtractor.getTextUnordered()`

    Methods in org.faceless.pdf2 that return PageExtractor.Text
    Modifier and Type | Method and Description
    --- | ---
    `abstract PageExtractor.Text` | PageExtractor.Text.`getPrimaryText()` If this text is a subtext or collection of Text object, return the primary text it starts with.
    `abstract PageExtractor.Text` | PageExtractor.Text.`getRowNext()` Return the next Text item in this row, or `null` if there are none
    `abstract PageExtractor.Text` | PageExtractor.Text.`getRowPrevious()` Return the next Text item in this row, or `null` if there are none
    `abstract PageExtractor.Text` | PageExtractor.Text.`getSubText(int off, int len)` Return a substring of this Text object as another Text object

    Methods in org.faceless.pdf2 that return types with arguments of type PageExtractor.Text
    Modifier and Type | Method and Description
    --- | ---
    `static Collection<PageExtractor.Text>` | PageExtractor.`cropText(Collection<PageExtractor.Text> all, Shape shape)` Given a Collection of `PageExtractor.Text` items, as returned by `getMatchingText()`, `PageExtractor.getTextUnordered()` or `PageExtractor.getTextInDisplayOrder()`, return a new Collection which contains only Text that falls completely inside the specified `Shape`.
    `Collection<PageExtractor.Text>` | PageExtractor.`getMatchingText(Pattern pattern)` Return a Collection of `PageExtractor.Text` items on this page that match the specified Regular Expression.
    `Collection<PageExtractor.Text>` | PageExtractor.`getMatchingText(String query)` Return a Collection of `PageExtractor.Text` items on this page that are equal to the specified substring.
    `Collection<PageExtractor.Text>` | PageExtractor.`getMatchingText(String[] queries)` Return a Collection of `PageExtractor.Text` items on this page that are equals to one of the specified substrings.
    `Collection<PageExtractor.Text>` | PageExtractor.`getMatchingText(String[] queries, boolean caseinsensitive)` Return a Collection of `PageExtractor.Text` items on this page that are equals to one of the specified substrings.
    `Collection<PageExtractor.Text>` | PageExtractor.`getText(Comparator<PageExtractor.Text> comp)` Return every `PageExtractor.Text` item on the page, in the specified order.
    `Collection<PageExtractor.Text>` | PageExtractor.`getTextInDisplayOrder()` Return every `PageExtractor.Text` item on the page, in the order they are displayed on the screen - so the first item in the returned collection will nearest to the top left of the page.
    `Collection<PageExtractor.Text>` | PageExtractor.`getTextUnordered()` Return every `PageExtractor.Text` item on the page, in the order they were added to the page.

    Methods in org.faceless.pdf2 with parameters of type PageExtractor.Text
    Modifier and Type | Method and Description
    --- | ---
    `AttributedString` | PageExtractor.`getStyledText(PageExtractor.Text first, int firstchar, PageExtractor.Text last, int lastchar, boolean displayorder)` Deprecated. see `PageExtractor.getStyledText(Text, int, Text, int, Comparator)`
    `AttributedString` | PageExtractor.`getStyledText(PageExtractor.Text first, int firstchar, PageExtractor.Text last, int lastchar, Comparator<PageExtractor.Text> order)` Return an AttributedString containing a contiguous range of text from this PageExtractor.
    `StringBuffer` | PageExtractor.`getText(PageExtractor.Text first, int firstchar, PageExtractor.Text last, int lastchar, boolean displayorder)` Deprecated. see `PageExtractor.getStyledText(Text, int, Text, int, Comparator)`
    `StringBuffer` | PageExtractor.`getText(PageExtractor.Text first, int firstchar, PageExtractor.Text last, int lastchar, Comparator<PageExtractor.Text> order)` Return a StringBuffer containing a contiguous range of text from this PageExtractor.

    Method parameters in org.faceless.pdf2 with type arguments of type PageExtractor.Text
    Modifier and Type | Method and Description
    --- | ---
    `static Collection<PageExtractor.Text>` | PageExtractor.`cropText(Collection<PageExtractor.Text> all, Shape shape)` Given a Collection of `PageExtractor.Text` items, as returned by `getMatchingText()`, `PageExtractor.getTextUnordered()` or `PageExtractor.getTextInDisplayOrder()`, return a new Collection which contains only Text that falls completely inside the specified `Shape`.
    `AttributedString` | PageExtractor.`getStyledText(PageExtractor.Text first, int firstchar, PageExtractor.Text last, int lastchar, Comparator<PageExtractor.Text> order)` Return an AttributedString containing a contiguous range of text from this PageExtractor.
    `Collection<PageExtractor.Text>` | PageExtractor.`getText(Comparator<PageExtractor.Text> comp)` Return every `PageExtractor.Text` item on the page, in the specified order.
    `StringBuffer` | PageExtractor.`getText(PageExtractor.Text first, int firstchar, PageExtractor.Text last, int lastchar, Comparator<PageExtractor.Text> order)` Return a StringBuffer containing a contiguous range of text from this PageExtractor.

  - ### Uses of PageExtractor.Text in org.faceless.pdf2.viewer2.feature

    Methods in org.faceless.pdf2.viewer2.feature that return PageExtractor.Text
    Modifier and Type | Method and Description
    --- | ---
    `abstract PageExtractor.Text` | TextSelection.Range.`getFirst()` Return the first `PageExtractor.Text` object that is selected
    `abstract PageExtractor.Text` | TextSelection.Range.`getLast()` Return the last `PageExtractor.Text` object that is selected

    Methods in org.faceless.pdf2.viewer2.feature with parameters of type PageExtractor.Text
    Modifier and Type | Method and Description
    --- | ---
    `void` | SearchPanel.Results.`addResult(PageExtractor.Text text)` Add the specified `PageExtractor.Text` to the list of results
    `static TextSelection.Range` | TextSelection.Range.`createRange(PageExtractor.Text text)` Create a new Range that matches the specified text item
    `static TextSelection.Range` | TextSelection.Range.`createRange(PageExtractor.Text first, int firstposition, PageExtractor.Text last, int lastposition)` Create a new Range that covers the range of text from `first` character `firstposition`. to `last` character `lastposition` inclusive.
    `void` | TextTool.`select(PageExtractor.Text text)` Select the specified text.

    Method parameters in org.faceless.pdf2.viewer2.feature with type arguments of type PageExtractor.Text
    Modifier and Type | Method and Description
    --- | ---
    `void` | TextTool.`select(Collection<PageExtractor.Text> texts)` Select the specified text objects.
    `void` | TextTool.`setOrder(Comparator<PageExtractor.Text> order)` Set the order in which text is selected in this TextTool, either `PageExtractor.NATURALORDER` or `PageExtractor.DISPLAYORDER`.

    Constructor parameters in org.faceless.pdf2.viewer2.feature with type arguments of type PageExtractor.Text
    Constructor and Description
    `RangeList(List<? extends TextSelection.Range> list, Comparator<PageExtractor.Text> order)` Create a RangeList containing a list of `TextSelection.Range` objects
    `RangeList(TextSelection.Range range, Comparator<PageExtractor.Text> order)` Create a RangeList containing a single `TextSelection.Range`

Copyright © 2001-2015 Big Faceless Organization