Class PropAttrEvent

All Implemented Interfaces:
IPostEventProcessing
Direct Known Subclasses:
PropErrorAttrEvent

public class PropAttrEvent extends BubbleEvent
The event that indicates that a property attribute has been set for the first time or when it has been changed.
Author:
Christopher Mindus
  • Field Details

    • PROP_ATTR_READ_ONLY

      public static final int PROP_ATTR_READ_ONLY
      Property attribute: read-only, event value = Boolean.
      See Also:
    • PROP_ATTR_PRIVATE

      public static final int PROP_ATTR_PRIVATE
      Property attribute: private, event value = Boolean.
      See Also:
    • PROP_ATTR_NULLABLE

      public static final int PROP_ATTR_NULLABLE
      Property attribute: nullable, event value = Boolean.
      See Also:
    • PROP_ATTR_PRIVATE_CHANGE_EVENT

      public static final int PROP_ATTR_PRIVATE_CHANGE_EVENT
      Property attribute: private change event, event value = Boolean.
      See Also:
    • PROP_ATTR_ERRORED_NAME

      public static final int PROP_ATTR_ERRORED_NAME
      Property attribute: errored property name, event value = String or null.
      See Also:
    • PROP_ATTR_ERROR

      public static final int PROP_ATTR_ERROR
      Property attribute: error, event value = PropError or null, event class PropErrorAttrEvent also contains the "errorID".
      See Also:
    • PROP_ATTR_EXTENDS_NAME

      public static final int PROP_ATTR_EXTENDS_NAME
      Property attribute: extends property name, event value = String or null.
      See Also:
    • PROP_ATTR_EXTENDS_PRIVATE

      public static final int PROP_ATTR_EXTENDS_PRIVATE
      Property attribute: extends private, event value = Boolean.
      See Also:
    • PROP_ATTR_EXTENDS_FINAL

      public static final int PROP_ATTR_EXTENDS_FINAL
      Property attribute: extends final, event value = Boolean.
      See Also:
    • PROP_ATTR_EXTENDS_OVERRIDE

      public static final int PROP_ATTR_EXTENDS_OVERRIDE
      Property attribute: extends override inhibit, event value = Atom or null.
      See Also:
    • PROP_ATTR_VSRELATIVE_MASK

      public static final int PROP_ATTR_VSRELATIVE_MASK
      Property attribute: VSRelativeReference change of mask value, event value = Integer.
      See Also:
  • Constructor Details

    • PropAttrEvent

      public PropAttrEvent(GProp<?> source, int attribute, Object newValue, Object oldValue, boolean isRemoteInduced)
      Constructs a new property event.
      Parameters:
      source - The source property instance being changed or initialized.
      attribute - The attribute being changed.
      newValue - The new value.
      oldValue - The old value or null if previously uninitialized.
      isRemoteInduced - Flag indicating this change is induced from a remote party.
  • Method Details

    • getAttribute

      public int getAttribute()
      Gets the attribute being changed, see the originating class for its values, normally values such as "PROP_ATTR_*".
    • getNewValue

      public Object getNewValue()
      Gets the new value.
      Returns:
      the new value, could be null.
    • getOldValue

      public Object getOldValue()
      Gets the old value.
      Returns:
      old value or null if previously uninitialized.
    • isClearCacheEvent

      public boolean isClearCacheEvent()
      Returns the state for a property container if this event is received in the onEventSelf method as a helper for it would need to clear the property container cache.
      Overrides:
      isClearCacheEvent in class GEvent
      Returns:
      true for error, extends and VS-relative., always for this event.
    • isVerifyEvent

      public boolean isVerifyEvent()
      Returns if this event is a verify event for a container that processes verification.
      Overrides:
      isVerifyEvent in class GEvent
      Returns:
      true always.
    • paramString

      protected StringBuilder paramString(StringBuilder buf)
      Returns the parameter string representing the state of this event. This string is useful for debugging. Super classes adds extra information to the string by preceding it with a comma followed by the extra information.
      Overrides:
      paramString in class GEvent
      Parameters:
      buf - The StringBuilder to append the string to.
      Returns:
      The StringBuilder, i.e. the buf input parameter.