Package com.biomatters.geneious.publicapi.components

Enum Dialogs.DialogIcon

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Dialogs.DialogIcon>
    Enclosing class:
    Dialogs
    public static enum Dialogs.DialogIcon
extends java.lang.Enum<Dialogs.DialogIcon>
    Specifies the icon to display on the left hand side of a dialog.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ERROR
      Normally a red octagon with an exclamation mark.
      INFORMATION
      Normally an 'i' icon.
      NO_ICON
      Display no icon in the dialog (also frees up the space that the icon would normally occupy).
      OUT_OF_MEMORY
      Display an icon indicating there was not enough available memory (a WARNING icon over the top of a memory icon)
      QUESTION
      Normally a question mark.
      WARNING
      Normally a yellow triangle with an exclamation mark.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.swing.Icon getIcon()
      Get the icon for this DialogIcon
      static Dialogs.DialogIcon valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Dialogs.DialogIcon[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • WARNING

        public static final Dialogs.DialogIcon WARNING
        Normally a yellow triangle with an exclamation mark. Use this if the user's response may result in permanent loss of data or other equally serious consequences.

      • ERROR

        public static final Dialogs.DialogIcon ERROR
        Normally a red octagon with an exclamation mark. Use this if an unexpected error has occurred (not if the user has entered invalid data etc, in this case use INFORMATION).

      • QUESTION

        public static final Dialogs.DialogIcon QUESTION
        Normally a question mark. Use this if you are asking the user a question.

      • INFORMATION

        public static final Dialogs.DialogIcon INFORMATION
        Normally an 'i' icon. Use this if you are telling the user some information.

      • OUT_OF_MEMORY

        public static final Dialogs.DialogIcon OUT_OF_MEMORY
        Display an icon indicating there was not enough available memory (a WARNING icon over the top of a memory icon)
        Since:
        API 4.910 (Geneious 9.1.0)

      • NO_ICON

        public static final Dialogs.DialogIcon NO_ICON
        Display no icon in the dialog (also frees up the space that the icon would normally occupy).

    • Method Detail

      • values

        public static Dialogs.DialogIcon[] 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 (Dialogs.DialogIcon c : Dialogs.DialogIcon.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Dialogs.DialogIcon 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

      • getIcon

        public javax.swing.Icon getIcon()
        Get the icon for this DialogIcon
        Returns:
        the icon for this DialogIcon or null if it doesn't have an icon.