Package hec.script

Class ScriptIdentifier

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.script.ScriptIdentifier
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, Serializable, Cloneable, Comparable, Observer, Modifiable
public class ScriptIdentifier extends NamedType implements Serializable, Comparable, AsciiSerializable
identifier to pull scripts
See Also:

  • Field Details

    • _fileName

      protected String _fileName
      identifies the file

    • _modulePath

      protected String _modulePath
      identifies the module location

    • _scriptId

      protected Object _scriptId

    • _userName

      protected String _userName
      name to display on button or menu

    • _displayedInMenu

      protected boolean _displayedInMenu
      whether to display in script menu

    • _displayedToUser

      protected boolean _displayedToUser
      whether to display on button

    • _displayScriptInSelector

      protected boolean _displayScriptInSelector
      whether to display in script selector

    • _fileNameOverridden

      protected boolean _fileNameOverridden
      has the user selected a different script file

    • _iconName

      protected String _iconName
      path to icon file

  • Constructor Details

    • ScriptIdentifier

      public ScriptIdentifier()

    • ScriptIdentifier

      public ScriptIdentifier(String userName, String name, String description, String fileName, String modulePath, Object scriptId, boolean displayedToUser, boolean fileNameOverridden)

    • ScriptIdentifier

      public ScriptIdentifier(String userName, String name, String description, String fileName, String modulePath, Object scriptId, boolean displayedInMenu, boolean displayedToUser, boolean fileNameOverridden)

    • ScriptIdentifier

      public ScriptIdentifier(String userName, String name, String description, String fileName, String modulePath, Object scriptId, boolean displayedInMenu, boolean displayedToUser, boolean displayScriptInSelector, boolean fileNameOverridden)

    • ScriptIdentifier

      public ScriptIdentifier(ScriptIdentifier sid)

  • Method Details

    • getFileName

      public String getFileName()

    • setFileName

      public void setFileName(String fileName)

    • setModulePath

      public void setModulePath(String modulePath)

    • setScriptId

      public void setScriptId(String scriptId)

    • getModulePath

      public String getModulePath()

    • getScriptId

      public Object getScriptId()

    • getUserDisplayedName

      public String getUserDisplayedName()

    • setUserDisplayedName

      public void setUserDisplayedName(String name)

    • isDisplayedInMenu

      public boolean isDisplayedInMenu()

    • isDisplayedToUser

      public boolean isDisplayedToUser()

    • isDisplayedInSelector

      public boolean isDisplayedInSelector()

    • setDisplayedInMenu

      public void setDisplayedInMenu(boolean b)

    • setDisplayedToUser

      public void setDisplayedToUser(boolean b)

    • setDisplayedInSelector

      public void setDisplayedInSelector(boolean b)

    • setFileNameOverridden

      public void setFileNameOverridden(boolean b)

    • getFileNameOverridden

      public boolean getFileNameOverridden()

    • getIconName

      public String getIconName()

    • setIconName

      public void setIconName(String name)

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • getHtmlDescription

      public String getHtmlDescription()
      return the description that is formatted for a tooltip
      Returns:
      the html formatted description

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • compareTo

      public int compareTo(Object obj)
      Specified by:
      compareTo in interface Comparable
      Overrides:
      compareTo in class NamedType

    • setBackgroundColorStr

      public void setBackgroundColorStr(String colorStr)

    • getBackgroundColorStr

      public String getBackgroundColorStr()

    • setGroupName

      public void setGroupName(String groupName)

    • getGroupName

      public String getGroupName()

    • getFieldObject

      public Object getFieldObject(Field fld)
      Description copied from interface: FieldAccessor
      This method allows access to java.lang.reflect.Field objects within the implementing class.
      Specified by:
      getFieldObject in interface FieldAccessor
      Overrides:
      getFieldObject in class NamedType
      Parameters:
      fld - The field to get.
      Returns:
      The data object that is stored in the given field

    • setFieldObject

      public boolean setFieldObject(Field fld, Object fobj)
      Description copied from interface: FieldAccessor
      This allows access to fields withing the implementing object to set there data.
      Specified by:
      setFieldObject in interface FieldAccessor
      Overrides:
      setFieldObject in class NamedType
      Parameters:
      fld - The java field object representing the member field to be set
      fobj - The data to set in that field
      Returns:
      returns true if successful

    • toString

      public String toString()
      Overrides:
      toString in class NamedType