Package ro.sync.ecss.extensions.commons.editor

Class InplaceEditorUtil

  • @API(type=INTERNAL,
     src=PUBLIC)
public final class InplaceEditorUtil
extends java.lang.Object
    Utility methods for preparing the in-place editors for being displayed.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static <T> T addToParent​(java.awt.Component component, java.awt.Container parent, java.util.function.Supplier<T> supplier)
      Adds the child inside the parent, calls the given supplier and requests the results from the supplier.
      static java.awt.Dimension getPreferredSize​(java.awt.Component component, java.awt.Container parent)
      Get the preferred size for the component.
      static Dimension getPreferredSize​(javax.swing.JComboBox comboBox, AuthorInplaceContext context)
      Computes the preferred size for the given combo box.
      static Dimension getPreferredSize​(javax.swing.JPanel panel, AuthorInplaceContext context)
      Computes the preferred size for the panel.
      static Dimension getPreferredSize​(javax.swing.JTextField textField, AuthorInplaceContext context)
      Computes the preferred size for the given text field.
      static void relayout​(javax.swing.JComboBox comboBox, AuthorInplaceContext context)
      Computes the required size for the editor and positions the caret at the end of the text.
      static void relayout​(javax.swing.JTextField textField, AuthorInplaceContext context)
      Computes the required size for the editor and positions the caret at the end of the text.
      static void setCaretAtEnd​(javax.swing.text.JTextComponent textField, AuthorInplaceContext context)
      Sets the caret at the end of the text from the text field.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getPreferredSize

        public static Dimension getPreferredSize​(javax.swing.JPanel panel,
                                         AuthorInplaceContext context)
        Computes the preferred size for the panel.
        Parameters:
        panel - A panel used as an editor.
        context - In-place editing context.
        Returns:
        The preferred size for the given context.

      • getPreferredSize

        public static Dimension getPreferredSize​(javax.swing.JComboBox comboBox,
                                         AuthorInplaceContext context)
        Computes the preferred size for the given combo box.
        Parameters:
        comboBox - A combo box used as an editor.
        context - In-place editing context.
        Returns:
        The preferred size for the given context.

      • getPreferredSize

        public static Dimension getPreferredSize​(javax.swing.JTextField textField,
                                         AuthorInplaceContext context)
        Computes the preferred size for the given text field.
        Parameters:
        textField - A text field used as an editor.
        context - In-place editing context.
        Returns:
        The preferred size for the given context.

      • relayout

        public static void relayout​(javax.swing.JComboBox comboBox,
                            AuthorInplaceContext context)
        Computes the required size for the editor and positions the caret at the end of the text. The caret offset will also be scrolled to be visible.
        Parameters:
        comboBox - Combo box used for editing.
        context - In-place editing context.

      • relayout

        public static void relayout​(javax.swing.JTextField textField,
                            AuthorInplaceContext context)
        Computes the required size for the editor and positions the caret at the end of the text. The caret offset will also be scrolled to be visible.
        Parameters:
        textField - Text field used for editing.
        context - In-place editing context.

      • setCaretAtEnd

        public static void setCaretAtEnd​(javax.swing.text.JTextComponent textField,
                                 AuthorInplaceContext context)
        Sets the caret at the end of the text from the text field.
        Parameters:
        textField - Text field to be scrolled.
        context - In-place editing context.

      • getPreferredSize

        public static java.awt.Dimension getPreferredSize​(java.awt.Component component,
                                                  java.awt.Container parent)
        Get the preferred size for the component.
        Parameters:
        component - The component.
        parent - The parent component, where the component will eventually be added.
        Returns:
        the baseline

      • addToParent

        public static <T> T addToParent​(java.awt.Component component,
                                java.awt.Container parent,
                                java.util.function.Supplier<T> supplier)
        Adds the child inside the parent, calls the given supplier and requests the results from the supplier.
        Parameters:
        component - The component.
        parent - The parent component, where the component will eventually be added.
        supplier - To be invoked.
        Returns:
        The results from the given supplier, after the component is added inside the parent.