Package com.biomatters.geneious.publicapi.plugin

Enum GeneiousActionOptions.MainMenu

    • Enum Constant Detail

      • New

        public static final GeneiousActionOptions.MainMenu New
        The New menu under the File menu. Actions in this menu can have a name that starts with "New " and it will be stripped off when displayed in the menu. This is so that the action can have "New " when it appears outside of the menu (eg. in the Keyboard shortcut preferences).
        Since:
        API 4.1000 (Geneious 10.0.0)

      • Tools

        public static final GeneiousActionOptions.MainMenu Tools
        The Tools menu. This menu should contain complex actions which can act on or produce documents other than individual sequences (eg. alignments, trees or large numbers of sequences). This menu is also suitable for database related actions and suites of related actions (eg. primers).

        Divider Positions:

        • below 0.1: major downstream analysis (alignment and tree building super-operations)
        • 0.1 to 0.2: lab-end analysis (eg. assembly and primers)
        • 0.2 to 0.3: database related actions (eg. Sequence search)
        • 0.3 to 0.9: other tools actions (eg. Strip alignment columns, extract annotations)
        • above 0.9: Preferences and Plugins actions

      • Sequence

        public static final GeneiousActionOptions.MainMenu Sequence
        The Sequence menu. This menu should contain simple actions which act on individual sequences to modify them or produce trivial output.

        Divider Positions:

        • below 0.1: the New Sequence operation
        • 0.1 to 0.3: extract type operations
        • 0.3 to 0.4: actions which change the properties of a sequence (eg. Convert between DNA and RNA)
        • 0.4 to 0.41: sequence list related operations
        • 0.4 to 0.45: set read operations
        • 0.45 to 0.49: other read operations
        • above 0.49: other sequence actions (eg. mutate/shuffle)

      • AnnotateAndPredict

        public static final GeneiousActionOptions.MainMenu AnnotateAndPredict
        The Annotate & Predict menu. Only SequenceAnnotationGenerators should be in this menu. Specifically ones that predict or annotate features. These actions will also appear in the Annotate & Predict menu within the sequence menu.

        Divider Positions:

        • below 0.015: Trim Functions
        • 0.015 to 0.023: Annotations
        • 0.023 to 0.033: Finds
        • 0.033 to 0.036: Crispr
        • 0.036 0.269: Tools
        • 0.269 to 0.51: Tools
        • above 0.51: Predict Tools

        As of API 4.202020 (Geneious 2020.2.0), Enum.toString() has been updated to return Annotate & Predict instead of the enum literal value.

        Since:
        API 4.11 (Geneious 5.0)

      • Pro

        @Deprecated
public static final GeneiousActionOptions.MainMenu Pro
        Deprecated.
        the pro menu no longer exists, do not use.
        This is not available to 3rd party plugins

    • Method Detail

      • values

        public static GeneiousActionOptions.MainMenu[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (GeneiousActionOptions.MainMenu c : GeneiousActionOptions.MainMenu.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static GeneiousActionOptions.MainMenu valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getDividers

        public java.util.List<GeneiousAction.Divider> getDividers()

        Gets the list of divider actions at their correct positions.

        Dividers should only be shown if there are menu items on both sides of the divider.

        Returns:
        An immutable list containing all the divider actions for this main menu.
        Since:
        API 4.202020 (Geneious 2020.2.0)