Package com.pnfsoftware.jeb.core.properties

Interface IPropertyDefinition

All Known Implementing Classes:
PropertyDefinition
public interface IPropertyDefinition
Definition of a property.

  • Field Details

    • FLAG_INTERNAL

      static final int FLAG_INTERNAL
      The property is internal and should not be displayed by clients.
      See Also:

    • FLAG_NOT_SUITABLE_FOR_RUN_TIME_OPTIONS

      static final int FLAG_NOT_SUITABLE_FOR_RUN_TIME_OPTIONS
      The property value is a setting not applicable for run-time modifications.
      See Also:

    • FLAG_URLENCODED

      static final int FLAG_URLENCODED
      The property value if URL-encoded (for strings only).
      See Also:

    • FLAG_VISUAL_STANDOUT

      static final int FLAG_VISUAL_STANDOUT
      This flag indicates that the description of this property is rather large. Clients rendering it may want to enclose it in a separate visual component.
      See Also:

    • FLAG_SIZE_TINY

      static final int FLAG_SIZE_TINY
      Visual size indicator.
      See Also:

    • FLAG_SIZE_SMALL

      static final int FLAG_SIZE_SMALL
      Visual size indicator.
      See Also:

    • FLAG_SIZE_MEDIUM

      static final int FLAG_SIZE_MEDIUM
      Visual size indicator. This value is useless.
      See Also:

    • FLAG_SIZE_LARGE

      static final int FLAG_SIZE_LARGE
      Visual size indicator.
      See Also:

    • FLAG_SIZE_EXTRA

      static final int FLAG_SIZE_EXTRA
      Visual size indicator.
      See Also:

  • Method Details

    • getManager

      IPropertyDefinitionManager getManager()
      Retrieve the manager for this definition.
      Returns:

    • getName

      String getName()
      Get the property name.
      Returns:
      the mandatory property name

    • getType

      IPropertyType getType()
      Get the property type.
      Returns:
      the mandatory property flags

    • getDescription

      String getDescription()
      Get a description string for the property.
      Returns:
      the mandatory property description (empty string if none)

    • getFlags

      int getFlags()
      Get the property flags.
      Returns:
      the property flags, a combination of FLAG_xxx constants

    • isInternal

      default boolean isInternal()
      Convenience method used to determine whether the property is internal. Internal properties should not displayed by clients.
      Returns:
      true if the property is internal