Package org.eclipse.xtext.xtext.generator.web

Class WebIntegrationFragment

    • Constructor Detail

      • WebIntegrationFragment

        public WebIntegrationFragment()

    • Method Detail

      • setFramework

        public void setFramework​(java.lang.String frameworkName)
        Choose one of the supported frameworks: "Orion", "Ace", or "CodeMirror"

      • setGenerateJsHighlighting

        public void setGenerateJsHighlighting​(boolean generateJsHighlighting)
        Whether JavaScript-based syntax highlighting should be generated. The default is true.

      • setHighlightingModuleName

        public void setHighlightingModuleName​(java.lang.String moduleName)
        Name of the syntax highlighting RequireJS module to be generated.

      • setHighlightingPath

        public void setHighlightingPath​(java.lang.String path)
        The path of the syntax highlighting JavaScript file to be generated. The default is to derive the path from the highlightingModuleName property.

      • setKeywordsFilter

        public void setKeywordsFilter​(java.lang.String keywordsFilter)
        Regular expression for filtering those language keywords that should be highlighted. The default is \w+, i.e. keywords consisting only of letters and digits.

      • setGenerateServlet

        public void setGenerateServlet​(boolean generateServlet)
        Whether a servlet for DSL-specific services should be generated. The default is false.

      • setGenerateWebXml

        public void setGenerateWebXml​(boolean generateWebXml)
        Whether a web.xml file should be generated. The default is false (not necessary for Servlet 3 compatible containers).

      • setUseServlet3Api

        public void setUseServlet3Api​(boolean useServlet3Api)
        Whether the Servlet 3 API (WebServlet annotation) should be used for the generated servlet. The default is true.

      • setIgnoreCase

        public void setIgnoreCase​(boolean ignoreCase)
        Whether the generated syntax highlighting should ignore case for language keywords.

      • setGenerateJettyLauncher

        public void setGenerateJettyLauncher​(boolean generateJettyLauncher)
        Whether a Java main-class for launching a local Jetty server should be generated. The default is false.

      • setGenerateHtmlExample

        public void setGenerateHtmlExample​(boolean generateHtmlExample)
        Whether an example index.html file for testing the web-based editor should be generated. The default is false.

      • addEnablePattern

        public void addEnablePattern​(java.lang.String pattern)
        Enable a default pattern for syntax highlighting. See the documentation of the chosen framework for details.

      • addSuppressPattern

        public void addSuppressPattern​(java.lang.String pattern)
        Suppress a default pattern for syntax highlighting. See the documentation of the chosen framework for details.

      • getServerLauncherClass

        protected TypeReference getServerLauncherClass​(org.eclipse.xtext.Grammar grammar)

      • getServletClass

        protected TypeReference getServletClass​(org.eclipse.xtext.Grammar grammar)

      • generate

        public void generate()

      • generateJsHighlighting

        protected void generateJsHighlighting​(java.lang.String langId)

      • generateKeywords

        protected java.lang.CharSequence generateKeywords​(java.util.List<java.lang.String> wordKeywords,
                                                  java.util.List<java.lang.String> nonWordKeywords)

      • generateKeywordsRegExp

        protected java.lang.CharSequence generateKeywordsRegExp()

      • generateExtraKeywordsRegExp

        protected java.lang.CharSequence generateExtraKeywordsRegExp()

      • createOrionPatterns

        protected java.util.Collection<java.lang.String> createOrionPatterns​(java.lang.String langId,
                                                                     java.util.Set<java.lang.String> keywords)

      • createCodeMirrorPatterns

        protected com.google.common.collect.Multimap<java.lang.String,​java.lang.String> createCodeMirrorPatterns​(java.lang.String langId,
                                                                                                               java.util.Set<java.lang.String> keywords)

      • generateIndexDoc

        protected void generateIndexDoc​(java.lang.String hlModName)

      • generateStyleSheet

        protected void generateStyleSheet()

      • generateServerLauncher

        protected void generateServerLauncher()

      • generateServlet

        protected void generateServlet()

      • generateWebXml

        protected void generateWebXml()

      • setRequireJsVersion

        public void setRequireJsVersion​(java.lang.String requireJsVersion)

      • setRequireJsTextVersion

        public void setRequireJsTextVersion​(java.lang.String requireJsTextVersion)

      • setJQueryVersion

        public void setJQueryVersion​(java.lang.String jQueryVersion)

      • setAceVersion

        public void setAceVersion​(java.lang.String aceVersion)

      • setCodeMirrorVersion

        public void setCodeMirrorVersion​(java.lang.String codeMirrorVersion)