Interface IEditedPropControllerOwner<PROP extends GProp<?>, PROP_VALUE>

All Known Implementing Classes:
BadgePropEditor, BaseEditor, BaseReferencePropEditor, BoolPropEditor, BoxShadowPropEditor, ClassReferencePropEditor, ColorPropEditor, ContentProviderPropEditor, DateTimePropEditor, DropShadowPropEditor, DurationPropEditor, EncodingPropEditor, FillPropEditor, FontFamilyPropEditor, FontPropEditor, GradientPropEditor, ImageReferencePropEditor, IntChoicePropEditor, IntPropEditor, KStringPropEditor, LocalizedStringPropEditor, LongPropEditor, MediaReferencePropEditor, MethodReferencePropEditor, MultiPropCnr, NullValueAllowedPropEditor, NumberPropEditor, PanelAnimationPropEditor, PasswordPropEditor, PatternPropEditor, PKCS12IdentityPropEditor, ReferencePropEditor, SizePropEditor, StringMapPropEditor, StringPropEditor, StrokePropEditor, StylesReferencesPropEditor, StylesStatesPropEditor, TextShadowPropEditor, ThemesPropEditor, TooltipPropEditor, TransformPropEditor, UIDateTimeTypePropEditor, UnitPropEditor, UnitsPropEditor, ValuePropEditor, ValueTypePropEditor, VAPIDKeyPropEditor, VSActionActorParticipantEditor, VSParticipantEditor, VSReferencePropEditor, VSRelativeReferencePropEditor, VSTableColumnReferencePropEditor, WrapStringPropEditor
public interface IEditedPropControllerOwner<PROP extends GProp<?>, PROP_VALUE>
Interface implemented by property editors.
Author:
Christopher Mindus

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    formatValue(PROP_VALUE value)
    Formats a value to a String, used to show a tool-tip in the editor.
    String
    getCurrentInput()
    Gets the current input string when it applies.
    PROP_VALUE
    getDefaultValue()
    Gets the default value for a property.
    void
    initialize(PROP prop)
    Initializes a newly created property (e.g.
    void
    onError(String input, String message, int severity, boolean isMultipleValueWarning, boolean isChildError)
    Called when the property is updated due to an error.
    void
    onReadOnly(boolean on)
    Called when the read-only state changes.
    void
    onUndefined()
    Called when the property is undefined.
    void
    onUpdate(PROP_VALUE value)
    Called when the property is updated without errors, with a new value.

  • Method Details

    • formatValue

      String formatValue(PROP_VALUE value)
      Formats a value to a String, used to show a tool-tip in the editor.

    • initialize

      void initialize(PROP prop) throws PropException
      Initializes a newly created property (e.g. a reference property for accepted classes, etc).
      Parameters:
      prop - The newly created orphan property.
      Throws:
      PropException - For property errors.

    • getDefaultValue

      PROP_VALUE getDefaultValue()
      Gets the default value for a property.

    • onUpdate

      void onUpdate(PROP_VALUE value)
      Called when the property is updated without errors, with a new value.

    • onUndefined

      void onUndefined()
      Called when the property is undefined.

    • onError

      void onError(String input, String message, int severity, boolean isMultipleValueWarning, boolean isChildError)
      Called when the property is updated due to an error.

    • onReadOnly

      void onReadOnly(boolean on)
      Called when the read-only state changes.

    • getCurrentInput

      String getCurrentInput()
      Gets the current input string when it applies.