Package org.gvsig.scripting

Interface ScriptingUnit

All Known Subinterfaces:
ScriptingBaseScript, ScriptingDialog, ScriptingExternalFile, ScriptingFolder, ScriptingScript, ScriptingText
public interface ScriptingUnit

Interface that represents the elements used in the ScriptingFramework.

See Also:

  • Method Details

    • getId

      String getId()
      Returns the ScriptingUnit's ID
      Returns:
      a String containing the ScriptingUnit's ID

    • getName

      String getName()
      Returns the ScriptingUnit's name
      Returns:
      a String containing the ScriptingUnit's name

    • getDescription

      String getDescription()
      Returns the ScriptingUnit's description
      Returns:
      a String containing the ScriptingUnit's description

    • getCreatedBy

      String getCreatedBy()
      Returns information about the ScriptingUnit's creator
      Returns:
      a String containing the ScriptingUnit's creator

    • getVersion

      String getVersion()
      Returns the ScriptingUnit's version
      Returns:
      a String containing the ScriptingUnit's version

    • getParent

      ScriptingFolder getParent()
      Returns the ScriptingUnit's parent
      Returns:
      a ScriptingFolder where is contained the ScriptingUnit

    • getUserPath

      String getUserPath()

    • setName

      void setName(String name)
      Sets a new name to the ScriptingUnit.
      Parameters:
      name - String that contains the new name.

    • setDescription

      void setDescription(String description)
      Sets a new description to the ScriptingUnit.
      Parameters:
      description - String that contains the new description.

    • setCreatedBy

      void setCreatedBy(String createdBy)
      Sets a new information about the ScriptingUnit's creator.
      Parameters:
      createdBy - String that contains the new creator's information.

    • setVersion

      void setVersion(String version)
      Sets a new version value to the ScriptingUnit.
      Parameters:
      version - String that contains the new version.

    • reload

      void reload()

    • rename

      boolean rename(String newId)
      Changes the ID of a ScriptingUnit and the name of the files and/or directories associated
      Parameters:
      newId - String that contains the new Id.
      Returns:
      true if it's succesful, false if not.

    • remove

      boolean remove()

    • move

      boolean move(ScriptingFolder target)
      Moves a ScriptingUnitfrom the current directory to the new location.
      Parameters:
      target - ScriptingFolder that represents the destination..
      Returns:
      true if it's succesful, false if not.

    • getIconNames

      String[] getIconNames()
      Gets the name of the icons associated to the ScriptingUnit type.
      Returns:
      a String array with the identificators of the icons associated.

    • getTypeName

      String getTypeName()

    • getFile

      File getFile()
      Gets a File with the ScriptUnit path name.
      Returns:
      a string with the path name of the ScriptUnit (inf/folder).

    • getFiles

      List<File> getFiles()
      Return a list of the files that use this unit with out the inf file.
      Returns:
      list of files of the unit.

    • addPropertyChangeListener

      void addPropertyChangeListener(PropertyChangeListener listener)

    • setSaved

      void setSaved(boolean saved)
      Sets the unit current status with the saved version.
      Parameters:
      saved - Indicate if the unit is up-to-date or not.

    • isSaved

      boolean isSaved()
      Indicates if the ScriptBaseScript is modified from last saved version.
      Returns:
      true if current version is up-to-date, false if not.

    • getProperty

      String getProperty(String name)

    • setProperty

      void setProperty(String name, String value)

    • getProperties

      Map<String,String> getProperties()

    • isASystemUnit

      boolean isASystemUnit()

    • getFileResource

      File getFileResource(String extension)