Skip navigation links
com.supermap.data

Class SteppedEvent

  • java.lang.Object
    • java.util.EventObject
      • com.supermap.data.SteppedEvent
  • All Implemented Interfaces:
    java.io.Serializable

    public class SteppedEvent
extends java.util.EventObject
    The SteppedEvent.

    This method is triggered when the rate of progress or the listener is changed.

    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor and Description
      SteppedEvent(java.lang.Object source, int percent, long remainTime, java.lang.String title, java.lang.String message, java.lang.String senderMethodName)
      Creates a new SteppedEvent object using given parameters.
      SteppedEvent(java.lang.Object source, int percent, long remainTime, java.lang.String title, java.lang.String message, java.lang.String senderMethodName, boolean cancel)
      Creates a new SteppedEvent object using given parameters.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean getCancel()
      Returns the cancel status of the event.
      java.lang.String getMessage()
      Returns the information of the current operation.
      int getPercent()
      Returns the percent of the completed the operation.
      long getRemainTime()
      Returns the remained time to complete the current operation.
      java.lang.String getSenderMethodName()
      Returns the name of the method invoked the current operation.
      java.lang.String getTitle()
      Returns the title of the current operation.
      void setCancel(boolean value)
      Sets the cancel status of the event.

      • Methods inherited from class java.util.EventObject

        getSource, toString

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • SteppedEvent

        public SteppedEvent(java.lang.Object source,
                    int percent,
                    long remainTime,
                    java.lang.String title,
                    java.lang.String message,
                    java.lang.String senderMethodName)
        Creates a new SteppedEvent object using given parameters.
        Parameters:
        source - The source object.
        percent - The percent of the current process have done.
        remainTime - The specified remained time to complete the current operation.
        title - The specified title of the current operation.
        message - The message of the current process.
        senderMethodName - The specified name of the method invoked the current operation.

      • SteppedEvent

        public SteppedEvent(java.lang.Object source,
                    int percent,
                    long remainTime,
                    java.lang.String title,
                    java.lang.String message,
                    java.lang.String senderMethodName,
                    boolean cancel)
        Creates a new SteppedEvent object using given parameters.
        Parameters:
        source - The source object.
        percent - The percent of the current process have done.
        remainTime - The specified remained time to complete the current operation, in milliseconds.
        title - The specified title of the current operation.
        message - The message of the current process.
        senderMethodName - The specified name of the method invoked the current operation.
        cancel - whether to cancel the progress bar.

    • Method Detail

      • getPercent

        public int getPercent()
        Returns the percent of the completed the operation.
        Returns:
        the percent of the completed the operation.

      • getRemainTime

        public long getRemainTime()
        Returns the remained time to complete the current operation. The unit is millisecond.
        Returns:
        the remained time to complete the current operation. The unit is millisecond.

      • getTitle

        public java.lang.String getTitle()
        Returns the title of the current operation.
        Returns:
        the title of the current operation.

      • getMessage

        public java.lang.String getMessage()
        Returns the information of the current operation.
        Returns:
        the information of the current operation.

      • getSenderMethodName

        public java.lang.String getSenderMethodName()
        Returns the name of the method invoked the current operation.

        The may be multiple methods to trigger the event.

        Returns:
        the name of the method invoked the current operation.

      • setCancel

        public void setCancel(boolean value)
        Sets the cancel status of the event.

        Only supported by the progress bar event in Processing.

        Parameters:
        value - Returns the cancel status of the event.

      • getCancel

        public boolean getCancel()
        Returns the cancel status of the event.
        Returns:
        the cancel status of the event.
Skip navigation links