Package ro.sync.ecss.extensions.api

Enum SelectionInterpretationMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SelectionInterpretationMode>
    @API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public enum SelectionInterpretationMode
extends java.lang.Enum<SelectionInterpretationMode>
    Impose how the selection is interpreted by the application.

    The TABLE_COLUMN interpretation mode is already set by default by the application when a table column is selected. In this case, when the column is pasted, it is also interpreted as a table column by the application built-in document types.
    To obtain this behavior for any selection, the TABLE_COLUMN interpretation mode must be imposed from AuthorSelectionModel.setSelectionInterpretationMode(SelectionInterpretationMode) method.
    For instance, when two paragraphs are copied, the clipboard object contains a list with two Author document fragments (one for each paragraph). If the selection interpretation mode is imposed to TABLE_COLUMN, when pasting the fragments a table column is created, each paragraph being the content of a column cell.

    For a custom document type, when a content with an imposed TABLE_COLUMN interpretation mode is pasted the AuthorTableOperationsHandler#handlePasteColumn(AuthorTablePasteColumnArguments) method is called. If there is no implementation for this extension, the default paste behavior is invoked.
    See ExtensionsBundle.getAuthorTableOperationsHandler() for handling the paste column operation.
    Since:
    14

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      TABLE
      Table selection interpretation.
      TABLE_CELLS
      Table cells selection interpretation (one or more table cells are selected).
      TABLE_COLUMN
      Table column selection interpretation.
      TABLE_ROW
      Table rows selection interpretation (one or more table rows are selected).

    • Method Summary

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

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static SelectionInterpretationMode[] 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 (SelectionInterpretationMode c : SelectionInterpretationMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SelectionInterpretationMode 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