Package org.apache.velocity.tools.generic

Class MarkupTool

  • @DefaultKey("mark")
public class MarkupTool
extends SafeConfig
    NOTE: This tools is considered "alpha" quality due to lack of testing and a generally unpolished API. Feel free to use but expect changes. Also, this is not automatically provided via the default tools.xml file.

    A tool to make it easy to generate XML or HTML on the fly. It uses a CSS-type syntax with a vaguely jQuery-ish API to help you generate the markup you need. 

     Example uses in a template:
   #set( $foospan = $markup.span.id($foo.id).body($foo) )
   $markup.tag('table tr.bar td').body("This is $foospan")

 Output:
   
    
     
    
       This is my first foo.
     
    
   
    


 Example tools.xml config:
 <tools>
   <toolbox scope="application">
     <tool class="org.apache.velocity.tools.generic.alpha.MarkupTool"/>
   </toolbox>
 </tools>

    Since:
    VelocityTools 2.0
    Version:
    $Id$
    Author:
    Nathan Bubna

    • Field Detail

      • DEFAULT_DELIMITER

        public static final java.lang.String DEFAULT_DELIMITER
        See Also:
        Constant Field Values

      • tab

        private java.lang.String tab

      • delim

        private java.lang.String delim

    • Constructor Detail

      • MarkupTool

        public MarkupTool()

    • Method Detail

      • setTab

        public void setTab​(java.lang.String tab)

      • getTab

        public java.lang.String getTab()

      • split

        protected java.lang.String[] split​(java.lang.String me)

      • parse

        protected MarkupTool.Tag parse​(java.lang.String definition)

      • clear

        private java.lang.StringBuilder clear​(MarkupTool.Mode mode,
                                      MarkupTool.Tag tag,
                                      java.lang.StringBuilder val,
                                      boolean emptyStore)