Package com.iizigo.clientpref

Interface IClientPref

All Known Implementing Classes:
BoolPref, ColorPref, IntPref, KeyPref, LinePref
public interface IClientPref
Interface used to create the client preference page with its validation. Each entry requires an instance of this interface.
Author:
Christopher Mindus

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    apply(PropCnr settings)
    Applies the settings.
    void
    createContents(org.eclipse.swt.widgets.Composite parent, PropCnr settings, ValidatorManager manager)
    Creates the contents.
    default String
    getHeading()
    Returns the heading text for a collapsable group.
    void
    setDefaults()
    Assigns the defaults for the property.

  • Method Details

    • getHeading

      default String getHeading()
      Returns the heading text for a collapsable group.
      Returns:
      null for normal contents, otherwise the group text.

    • createContents

      void createContents(org.eclipse.swt.widgets.Composite parent, PropCnr settings, ValidatorManager manager)
      Creates the contents. The parent has a GridLayout of 2 columns and the first column is used for the text prompt.
      Parameters:
      parent - The parent composite.
      settings - The property container.
      manager - The validator manager.

    • setDefaults

      void setDefaults()
      Assigns the defaults for the property.

    • apply

      String apply(PropCnr settings)
      Applies the settings.
      Parameters:
      settings - The settings.
      Returns:
      The error if this failed, or null for OK.