Class EditorVariableDescription


  • @API(type=EXTENDABLE,
         src=PUBLIC)
    public class EditorVariableDescription
    extends java.lang.Object
    An editor variable's description (name and short desc).
    Since:
    18.1
    • Constructor Summary

      Constructors 
      Constructor Description
      EditorVariableDescription​(java.lang.String name, java.lang.String shortDescription)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Get the editor variable name.
      java.lang.String getShortDescription()
      Get the editor variable short description.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • EditorVariableDescription

        public EditorVariableDescription​(java.lang.String name,
                                         java.lang.String shortDescription)
        Constructor.
        Parameters:
        name - The editor variable name. Must not be null.
        shortDescription - The short description.
    • Method Detail

      • getName

        public java.lang.String getName()
        Get the editor variable name.
        Returns:
        Returns the editor variable name.
      • getShortDescription

        public java.lang.String getShortDescription()
        Get the editor variable short description.
        Returns:
        Returns the editor variable short description..