Package org.pentaho.reporting.tools.configeditor.editor

Interface KeyEditor

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      JComponent getComponent()
      Returns the editor component used to display the key editor in the GUI.
      int getLabelWidth()
      Returns the width of the label component.
      boolean isDefined()
      Checks whether the key is defined locally in the report configuration of the editor.
      boolean isEnabled()
      Returns true, if the editor component is enabled, false otherwise.
      void reset()
      Resets the value to the original value from the report configuration.
      void setEnabled​(boolean b)
      Defines, whether the key editor should be enabled.
      void setLabelWidth​(int width)
      Sets the width of the label for the editor component.
      void store()
      Stores the value into the report configuration.

    • Method Detail

      • setEnabled

        void setEnabled​(boolean b)
        Defines, whether the key editor should be enabled.
        Parameters:
        b - true, if the editor should be enabled, false otherwise.

      • isEnabled

        boolean isEnabled()
        Returns true, if the editor component is enabled, false otherwise.
        Returns:
        true, if the editor component is enabled, false otherwise.

      • setLabelWidth

        void setLabelWidth​(int width)
        Sets the width of the label for the editor component. This is a layout hint to help the module editor to build a suitable table layout.
        Parameters:
        width - the preferred width for the label.

      • getLabelWidth

        int getLabelWidth()
        Returns the width of the label component. Return 0 if no label component is used.
        Returns:
        the width of the lable component.

      • isDefined

        boolean isDefined()
        Checks whether the key is defined locally in the report configuration of the editor.
        Returns:
        true, if the local configuration provides the value for the editor, false if the value is read from the default configuration.

      • getComponent

        JComponent getComponent()
        Returns the editor component used to display the key editor in the GUI.
        Returns:
        the editor component.

      • reset

        void reset()
        Resets the value to the original value from the report configuration.

      • store

        void store()
        Stores the value into the report configuration.