Package com.pdftools.toolbox.pdf.content

Enum UngroupingSelection

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<UngroupingSelection>
    public enum UngroupingSelection
extends java.lang.Enum<UngroupingSelection>
    Used to control the behavior of content extraction. Groups in the content can either be extracted as GroupElements, or their content can be unpacked, in which case groups' content elements are extracted as if not belonging to a group.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL
      Un-group all groups.
      NONE
      Groups are extracted as GroupElements
      SAFELY_UNGROUPABLE
      Un-grouping is restricted to those groups that can be un-grouped without visual loss.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static UngroupingSelection valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static UngroupingSelection[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • SAFELY_UNGROUPABLE

        public static final UngroupingSelection SAFELY_UNGROUPABLE
        Un-grouping is restricted to those groups that can be un-grouped without visual loss.

      • ALL

        public static final UngroupingSelection ALL
        Un-group all groups. Note that copying ContentElements with un-grouping set to ALL can alter content's visual appearance in the output document.

    • Method Detail

      • values

        public static UngroupingSelection[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (UngroupingSelection c : UngroupingSelection.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static UngroupingSelection valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null