Package hec.appInterface

Interface Workspace

All Superinterfaces:
FileOpener
All Known Subinterfaces:
MapWorkspace
public interface Workspace extends FileOpener

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getRelativePath(String fullpath)
    if fullPath is relative to the workspace then, strip off the workspace path and return just the portion after the workspace path, otherwise return the entire path
    String
    getTitleName()
    get the workspace name to display to the user on title bars etc.
    String
    getWorkspacePath()
    Get the full path to the where the Workspace resides on disk.
    boolean
    isModified()
    get whether the Workspace has been modified.
    boolean
    setManagerOrder(List orderedManagerIds)
    Set the order that non-map schematic layers are drawn as specified by the hec.map.MapIdentifiers in the list orderedManagerIds.
    void
    setModified(boolean modified)
    set the Workspace to be modified or not

    Methods inherited from interface hec.appInterface.FileOpener

    createFile, getDriveList, getFileList, lockFile, openFile, unlockFile

  • Method Details

    • setManagerOrder

      boolean setManagerOrder(List orderedManagerIds)
      Set the order that non-map schematic layers are drawn as specified by the hec.map.MapIdentifiers in the list orderedManagerIds.
      Parameters:
      orderedManagerIds - the List of ordered hec.map.MapIdentifiers

    • getWorkspacePath

      String getWorkspacePath()
      Get the full path to the where the Workspace resides on disk.
      Returns:
      the fullpath to the workspace

    • getTitleName

      String getTitleName()
      get the workspace name to display to the user on title bars etc.
      Returns:
      the workspace name

    • isModified

      boolean isModified()
      get whether the Workspace has been modified.
      Returns:
      true if the Workspace has been modified

    • setModified

      void setModified(boolean modified)
      set the Workspace to be modified or not
      Parameters:
      modified - true to set the Workspace modified.

    • getRelativePath

      String getRelativePath(String fullpath)
      if fullPath is relative to the workspace then, strip off the workspace path and return just the portion after the workspace path, otherwise return the entire path
      Parameters:
      fullpath - the fullpath
      Returns:
      The path relative to the workspace or if fullPath isnt relative to the workspace fullPath