Package ro.sync.ecss.extensions.api.webapp.doctype

Interface DocumentTypeInfo

@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface DocumentTypeInfo
Information about a document type.
Since:
15.2

  • Method Details

    • getFrameworkFolder

      File getFrameworkFolder()
      Returns the location on disk of the framework folder.
      Returns:
      The location on disk of the framework folder.

    • getBaseFrameworkFolder

      File getBaseFrameworkFolder()
      Returns:
      The location on disk of the base framework folder or null if this document type is not an extension.
      Since:
      18.1.1

    • getFrameworkFile

      File getFrameworkFile()
      Returns the location on disk of the framework file.
      Returns:
      The location on disk of the framework file.

    • getId

      String getId()
      Returns the id of the document type.
      Returns:
      the id of the document type.

    • getDescription

      String getDescription()
      Returns a description of the framework.
      Returns:
      a description of the framework.

    • getName

      String getName()
      Returns the name of the framework.
      Returns:
      the name of the framework.

    • isEnabled

      boolean isEnabled()
      Returns:
      true if the framework is enabled.

    • getAvailableCssGroups

      List<CSSGroup> getAvailableCssGroups()
      Returns the list of CSS groups defined in the framework.
      Returns:
      The list of CSS groups defined in the framework.
      Since:
      20.1

    • getWebResources

      List<File> getWebResources()
      Returns:
      a list of JS files or folders containing js files that will be loaded client-side by the Web Author.
      Since:
      23.1

    • getAuthorResourceBundle

      AuthorResourceBundle getAuthorResourceBundle()
      A message bundle that holds all the internationalized messages contrbuted by the current document type.
      Returns:
      The message bundle.
      Since:
      24

    • getPriority

      int getPriority()
      Getter for the document type priority.
      Returns:
      the document type priority (value between 1 and 5) used when matching to a document.
      Since:
      24.1

    • validate

      List<String> validate()
      Checks if the framework contains invalid references.
      Returns:
      A list of validation error messages or an empty list if the framework is valid.