Package com.ebasetech.xi.api

Interface Project

public interface Project

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getAppLayoutPath()
    Returns the path of the Layout currently set on the project or null if no Layout is configured.
    java.lang.String getName()
    Returns the project name for the project.
    java.lang.String getTheme()
    Deprecated.
    use getThemePath
    java.lang.String getThemePath()
    Returns the path of the theme currently set on the project or null if no theme is configured.
    void setAppLayoutPath​(java.lang.String path)
    Changes the Layout for the Project.
    void setTheme​(java.lang.String theme)
    Deprecated.
    use setThemePath
    void setThemePath​(java.lang.String theme)
    Changes the Theme for the Project.

  • Method Details

    • setThemePath

      void setThemePath​(java.lang.String theme)
      Changes the Theme for the Project. This will change all the forms in the Project that are set to use the Project's Theme to the one at the specified path.

      The path should be relative to the root of the Project or one of its dependent projects. It must start with a forward slash as a path separator.

      The new Theme must have the same Framework and collection of Property Sets as the current Theme otherwise the Form may not look as expected.

      For further information see:

      JavaScript example: 

       var project = projects.myProject;
 project.setTheme("/themes/myTheme");
      Parameters:
      theme - the path of the new theme to be applied
      Since:
      V5.14

    • setTheme

      void setTheme​(java.lang.String theme)
      Deprecated.
      use setThemePath
      Since:
      V5.13

    • getThemePath

      java.lang.String getThemePath()
      Returns the path of the theme currently set on the project or null if no theme is configured.
      Returns:
      the theme path
      Since:
      V5.14

    • getTheme

      java.lang.String getTheme()
      Deprecated.
      use getThemePath
      Since:
      V5.13

    • setAppLayoutPath

      void setAppLayoutPath​(java.lang.String path)
      Changes the Layout for the Project. This will change all the forms in the Project that are set to use the Project's Layout to the one at the specified path.

      The path should be relative to the root of the Project or one of its dependent projects. It must start with a forward slash as a path separator.

      The new Layout must have the same Framework and collection of Property Sets as the current Theme otherwise the Form may not look as expected.

      For further information see:

      JavaScript example: 

       var project = projects.myProject;
 project.setAppLayout("/layouts/myLayout");
      Parameters:
      path - the path of the layout to be applied
      Since:
      V5.14

    • getAppLayoutPath

      java.lang.String getAppLayoutPath()
      Returns the path of the Layout currently set on the project or null if no Layout is configured.
      Returns:
      the layout path
      Since:
      V5.14

    • getName

      java.lang.String getName()
      Returns the project name for the project.
      Returns:
      project name
      Since:
      V5.13