Package com.iizigo.prop

Class PasteFeedback

java.lang.Object
com.iizigo.prop.PasteFeedback
Direct Known Subclasses:
PasteFeedback.DropValidationFeedback
public class PasteFeedback extends Object
Paste feed-back. This class is returned in response to the Designer Property Paste operation in order to provide visual feed-back on the operation, typically if the operation is allowed (if Paste was requested without perform the actual paste) or successful (if performed).

The error message is set when the operation cannot be performed or failed. The feed-back members indicate how the operation would take place or has taken place.

Author:
Christopher Mindus

  • Field Details

    • ERR_TARGET_DOES_NOT_SUPPORT_OPERATION

      public static final PasteFeedback ERR_TARGET_DOES_NOT_SUPPORT_OPERATION
      Standard error: "Target does not support operation".

    • ERR_INVALID_OPERATION

      public static final PasteFeedback ERR_INVALID_OPERATION
      Standard error: "Invalid operation".

    • ERR_TARGET_READ_ONLY

      public static final PasteFeedback ERR_TARGET_READ_ONLY
      Standard error: "Target is read-only".

    • ERR_ELEMENT_READ_ONLY

      public static final PasteFeedback ERR_ELEMENT_READ_ONLY
      Standard error: "Element is read-only".

    • ERR_FILE_NOT_LOADED

      public static final PasteFeedback ERR_FILE_NOT_LOADED
      Standard error: "Unsupported operation: file is not loaded".

    • FEEDBACK_PASTE_IN_TARGET

      public static final int FEEDBACK_PASTE_IN_TARGET
      Feed-back for paste into selected target container (non-index based target container).
      See Also:

    • FEEDBACK_PASTE_IN_TARGET_FOLDER

      public static final int FEEDBACK_PASTE_IN_TARGET_FOLDER
      Feed-back for paste into selected container's folder parent (resource based).
      See Also:

    • FEEDBACK_PASTE_BEFORE_TARGET_IN_PARENT

      public static final int FEEDBACK_PASTE_BEFORE_TARGET_IN_PARENT
      Feed-back for paste into selected container's parent before the target.
      See Also:

    • FEEDBACK_PASTE_AFTER_TARGET_IN_PARENT

      public static final int FEEDBACK_PASTE_AFTER_TARGET_IN_PARENT
      Feed-back for paste into selected container's parent after the target.
      See Also:

    • FEEDBACK_CANCELED_BY_USER

      public static final int FEEDBACK_CANCELED_BY_USER
      Feed-back for operation canceled by user due to e.g. dialog boxes.
      See Also:

    • FEEDBACK_VALID_DROPS

      public static final int FEEDBACK_VALID_DROPS
      Feed-back for valid drops.
      See Also:

    • OK_PASTE_IN_TARGET

      public static final PasteFeedback OK_PASTE_IN_TARGET
      Success: paste in target: feedBack = FEEDBACK_IN_TARGET.

    • OK_PASTE_IN_TARGET_FOLDER

      public static final PasteFeedback OK_PASTE_IN_TARGET_FOLDER
      Success: paste in target folder: feedBack = FEEDBACK_IN_TARGET_FOLDER.

    • OK_PASTE_BEFORE_TARGET_IN_PARENT

      public static final PasteFeedback OK_PASTE_BEFORE_TARGET_IN_PARENT
      Success: paste before target in target parent: feedBack = FEEDBACK_BEFORE_TARGET_IN_PARENT.

    • OK_PASTE_AFTER_TARGET_IN_PARENT

      public static final PasteFeedback OK_PASTE_AFTER_TARGET_IN_PARENT
      Success: paste after target in target parent: feedBack = FEEDBACK_AFTER_TARGET_IN_PARENT.

    • OK_CANCELED_BY_USER

      public static final PasteFeedback OK_CANCELED_BY_USER
      Success: operation canceled by user due to e.g. dialog boxes.

    • message

      public final String message
      Error message, null indicates no error.

    • status

      public final IStatus status
      Potential status code, if originating from a status, otherwise null.

    • feedBack

      public final int feedBack
      Feed-back value, -1 for not defined.

  • Constructor Details

    • PasteFeedback

      public PasteFeedback(IStatus status) throws IllegalArgumentException
      Constructor for error message from status. If status isOK(), this method will cause IllegalArgumentException!
      Throws:
      IllegalArgumentException - If status.isOK() is true.

    • PasteFeedback

      public PasteFeedback(String message)
      Constructor for paste not allowed or error in paste.

  • Method Details

    • isOK

      public boolean isOK()
      Checks for OK, i.e. that message is null, status is OK or INFO.

    • getStatus

      public IStatus getStatus()
      Gets a status out of the feed-back.

    • toString

      public String toString()
      Shows as string for debug.
      Overrides:
      toString in class Object

    • paramString

      protected String paramString()
      Param-string is overridden in super classes.