Package adams.gui.menu

Class Annotator

  • All Implemented Interfaces:
    Serializable, Comparable<adams.gui.application.AbstractMenuItemDefinition>
    public class Annotator
extends adams.gui.application.AbstractBasicMenuItemDefinition
    For annotating videos
    Version:
    $Revision: 11391 $
    Author:
    Steven Brown (sjb90 at students dot waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class adams.gui.application.AbstractMenuItemDefinition

        CATEGORY_HELP, CATEGORY_MACHINELEARNING, CATEGORY_MAINTENANCE, CATEGORY_PROGRAM, CATEGORY_TOOLS, CATEGORY_VISUALIZATION, CATEGORY_WIZARD, m_Owner

    • Constructor Summary

      Constructors 
      Constructor Description
      Annotator()
      Initializes the menu item with no owner.
      Annotator​(adams.gui.application.AbstractApplicationFrame owner)
      Initializes the menu item.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getCategory()
      Returns the category of the menu item in which it should appear, i.e., the name of the menu.
      String getIconName()
      Returns the file name of the icon.
      String getTitle()
      Returns the title of the window (and text of menuitem).
      adams.core.option.UserMode getUserMode()
      Returns the user mode, which determines visibility as well.
      boolean isSingleton()
      Whether the panel can only be displayed once.
      void launch()
      Launches the functionality of the menu item.

      • Methods inherited from class adams.gui.application.AbstractBasicMenuItemDefinition

        getMenuItem, getUseThread, postLaunch, preLaunch

      • Methods inherited from class adams.gui.application.AbstractMenuItemDefinition

        compareTo, createChildFrame, createChildFrame, equals, forCommandLine, forName, getActualCategory, getIcon, getLogger, getOwner, initialize, isAvailable, requiresRestartableApplication, setOwner

    • Constructor Detail

      • Annotator

        public Annotator()
        Initializes the menu item with no owner.

      • Annotator

        public Annotator​(adams.gui.application.AbstractApplicationFrame owner)
        Initializes the menu item.
        Parameters:
        owner - the owning application

    • Method Detail

      • getIconName

        public String getIconName()
        Returns the file name of the icon.
        Overrides:
        getIconName in class adams.gui.application.AbstractMenuItemDefinition
        Returns:
        the filename or null if no icon available

      • launch

        public void launch()
        Launches the functionality of the menu item.
        Specified by:
        launch in class adams.gui.application.AbstractBasicMenuItemDefinition

      • getTitle

        public String getTitle()
        Returns the title of the window (and text of menuitem).
        Specified by:
        getTitle in class adams.gui.application.AbstractMenuItemDefinition
        Returns:
        the title

      • isSingleton

        public boolean isSingleton()
        Whether the panel can only be displayed once.
        Specified by:
        isSingleton in class adams.gui.application.AbstractMenuItemDefinition
        Returns:
        true if the panel can only be displayed once

      • getUserMode

        public adams.core.option.UserMode getUserMode()
        Returns the user mode, which determines visibility as well.
        Specified by:
        getUserMode in class adams.gui.application.AbstractMenuItemDefinition
        Returns:
        the user mode

      • getCategory

        public String getCategory()
        Returns the category of the menu item in which it should appear, i.e., the name of the menu.
        Specified by:
        getCategory in class adams.gui.application.AbstractMenuItemDefinition
        Returns:
        the category/menu name