Package jpicedt.graphic.toolkit

Class AbstractMouseTransformFactory.HelpMessageMouseTransform

  • All Implemented Interfaces:
    MouseTransform
    Enclosing class:
    AbstractMouseTransformFactory
    protected class AbstractMouseTransformFactory.HelpMessageMouseTransform
extends java.lang.Object
implements MouseTransform
    This mouse transform does nothing, it is just a convenience to post a HelpMessage (regarding what the user COULD do) when no other mouse-transform makes sense with the current mouse-event.
    Since:
    jpicedt 1.3.2

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.awt.Cursor getCursor()
      Return the cursor for this MouseTransform
      java.lang.String getHelpMessage()
      Return a help-message for the UI, that makes sense with this transform.
      boolean next​(PEMouseEvent e)
      Called when the mouse is released
      void paint​(java.awt.Graphics2D g, java.awt.geom.Rectangle2D allocation, double scale)
      Allows the MouseTransform to do specific graphic rendering when it's operating.
      void process​(PEMouseEvent e)
      Called when the mouse is dragged.
      void start​(PEMouseEvent e)
      Called when the mouse is pressed.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • HelpMessageMouseTransform

        public HelpMessageMouseTransform​(java.lang.String helpMsg)

    • Method Detail

      • start

        public void start​(PEMouseEvent e)
        Called when the mouse is pressed. The transform should do the initialization work here.
        Specified by:
        start in interface MouseTransform
        Since:
        jpicedt 1.3.2

      • process

        public void process​(PEMouseEvent e)
        Called when the mouse is dragged. Element geometry update should occur here.
        Specified by:
        process in interface MouseTransform
        Since:
        jpicedt 1.3.2

      • next

        public boolean next​(PEMouseEvent e)
        Called when the mouse is released
        Specified by:
        next in interface MouseTransform
        Returns:
        true if there's another task in the sequence, false if mouse-transform has completed with this mouse-event.
        Since:
        jpicedt 1.3.2

      • getCursor

        public java.awt.Cursor getCursor()
        Description copied from interface: MouseTransform
        Return the cursor for this MouseTransform
        Specified by:
        getCursor in interface MouseTransform
        Returns:
        the cursor for this MouseTransform
        Since:
        jpicedt 1.3.2

      • paint

        public void paint​(java.awt.Graphics2D g,
                  java.awt.geom.Rectangle2D allocation,
                  double scale)
        Allows the MouseTransform to do specific graphic rendering when it's operating.
        Specified by:
        paint in interface MouseTransform
        Since:
        jpicedt 1.3.2

      • getHelpMessage

        public java.lang.String getHelpMessage()
        Description copied from interface: MouseTransform
        Return a help-message for the UI, that makes sense with this transform.
        Specified by:
        getHelpMessage in interface MouseTransform
        Returns:
        a help-message for the UI, that makes sense with this transform.