Package org.gorpipe.querydialogs

Interface FilteringColumnDefinition

  • public interface FilteringColumnDefinition
    Interface for filtering column definition.

    • Method Detail

      • hasShortDescription

        boolean hasShortDescription()
        Check if the column definition has a short description.
        Returns:
        true if the column definition has a short description, otherwise false

      • getShortDescription

        java.lang.String getShortDescription()
        Get the short description of column (few words).
        Returns:
        the short description of column

      • hasDescription

        boolean hasDescription()
        Check if the column definition has a description.
        Returns:
        true if the column definition has a description, otherwise false

      • getDescription

        java.lang.String getDescription()
        Get the description of the column (one sentence).
        Returns:
        the description of the column

      • hasColumnHelp

        boolean hasColumnHelp()
        Check if help is defined for column.
        Returns:
        true if help is defined for column, otherwise false

      • displayHelp

        void displayHelp​(java.awt.Window parent)
        Display detailed help for the column.
        Parameters:
        parent - the parent window of the component displaying help

      • getDescriptionPanelWithHyperlink

        javax.swing.JPanel getDescriptionPanelWithHyperlink​(javax.swing.JComponent toolTipViewer)
        The description is displayed in a panel. If the description does not fit in the panel a '...more' hyperlink is added at the end of the partial description. When the hyperlink is pressed a popup dialog should display the complete description.
        Parameters:
        toolTipViewer - a tooltip viewer to use for pinning description
        Returns:
        panel for displaying the description