Class AbstractMouseClickProcessor

    • Field Detail

      • m_Enabled

        protected boolean m_Enabled
        whether the overlay is enabled.
      • m_ClickCount

        protected int m_ClickCount
        the required click count (< 1 if irrelevant).
      • m_ShiftDown

        protected boolean m_ShiftDown
        whether shift needs to be down.
      • m_AltDown

        protected boolean m_AltDown
        whether alt needs to be down.
      • m_CtrlDown

        protected boolean m_CtrlDown
        whether ctrl needs to be down.
      • m_MetaDown

        protected boolean m_MetaDown
        whether meta needs to be down.
    • Constructor Detail

      • AbstractMouseClickProcessor

        public AbstractMouseClickProcessor()
    • Method Detail

      • setEnabled

        public void setEnabled​(boolean value)
        Sets whether the click processor is enabled.
        Parameters:
        value - true if enabled
      • getEnabled

        public boolean getEnabled()
        Returns whether the click processor is enabled.
        Returns:
        true if enabled
      • enabledTipText

        public String enabledTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • buttonTipText

        public String buttonTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setClickCount

        public void setClickCount​(int value)
        Sets the number of mouse clicks; use 0 for turning check off; use 2 for double click.
        Parameters:
        value - the count
      • getClickCount

        public int getClickCount()
        Returns the number of mouse clicks; use 0 for turning check off; use 2 for double click.
        Returns:
        the count
      • clickCountTipText

        public String clickCountTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setShiftDown

        public void setShiftDown​(boolean value)
        Sets whether the shift key needs to be down.
        Parameters:
        value - true if needs to be down
      • getShiftDown

        public boolean getShiftDown()
        Returns whether the shift key needs to be down.
        Returns:
        true if needs to be down
      • shiftDownTipText

        public String shiftDownTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setAltDown

        public void setAltDown​(boolean value)
        Sets whether the alt key needs to be down.
        Parameters:
        value - true if needs to be down
      • getAltDown

        public boolean getAltDown()
        Returns whether the alt key needs to be down.
        Returns:
        true if needs to be down
      • altDownTipText

        public String altDownTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setCtrlDown

        public void setCtrlDown​(boolean value)
        Sets whether the ctrl key needs to be down.
        Parameters:
        value - true if needs to be down
      • getCtrlDown

        public boolean getCtrlDown()
        Returns whether the ctrl key needs to be down.
        Returns:
        true if needs to be down
      • ctrlDownTipText

        public String ctrlDownTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setMetaDown

        public void setMetaDown​(boolean value)
        Sets whether the meta key needs to be down.
        Parameters:
        value - true if needs to be down
      • getMetaDown

        public boolean getMetaDown()
        Returns whether the meta key needs to be down.
        Returns:
        true if needs to be down
      • metaDownTipText

        public String metaDownTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • determineHits

        protected LocatedObjects determineHits​(ObjectAnnotationPanel panel,
                                               MouseEvent e)
        Determines the object hits for the mouse location.
        Parameters:
        panel - the owning panel
        e - the mouse event/location
        Returns:
        the hits
      • doProcess

        protected abstract void doProcess​(ObjectAnnotationPanel panel,
                                          MouseEvent e)
        Processes the mouse event.
        Parameters:
        panel - the owning panel
        e - the event
      • process

        public void process​(ObjectAnnotationPanel panel,
                            MouseEvent e)
        Processes the mouse event.
        Parameters:
        panel - the owning panel
        e - the event