Package org.concordion.api

Annotation Interface ConcordionResources

@Target(TYPE) @Retention(RUNTIME) @Inherited public @interface ConcordionResources
Includes resource files such as CSS, JavaScript, images, etc along with the generated specification.
Since:
2.0.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    ConcordionResources.InsertType
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    includeDefaultStyling
     
    ConcordionResources.InsertType
    insertType
    Controls how CSS and JavaScript files are added to the specification, choices are LINKED (default) or EMBEDDED
    String[]
    value
    Specify one or more files to add to the generated specification: File names starting with '/' are relative to the root folder File names not starting with '/' are relative to the class the annotation is applied to Supports wild card characters '*' and '?' in the file name ("/images/*.png", "/css/*.*") CSS and JS files are automatically added to the <head> section (see insertType parameter) All other file types must be manually added to the specification

  • Element Details

    • value

      String[] value
      Specify one or more files to add to the generated specification:
      • File names starting with '/' are relative to the root folder
      • File names not starting with '/' are relative to the class the annotation is applied to
      • Supports wild card characters '*' and '?' in the file name ("/images/*.png", "/css/*.*")
      • CSS and JS files are automatically added to the <head> section (see insertType parameter)
      • All other file types must be manually added to the specification
      Returns:
      Array of files
      Default:
      {}

    • insertType

      ConcordionResources.InsertType insertType
      Controls how CSS and JavaScript files are added to the specification, choices are LINKED (default) or EMBEDDED
      Returns:
      InsertType
      Default:
      LINKED

    • includeDefaultStyling

      boolean includeDefaultStyling
      Returns:
      If false will remove the default Concordion CSS styling (defaults to true)
      Default:
      true