Class LayoutTag

  • All Implemented Interfaces:
    ConditionalTag, org.apache.commons.jelly.Tag
    Direct Known Subclasses:
    BorderLayoutTag, ButtonLayoutTag, PercentLayoutTag

    public abstract class LayoutTag
    extends FormBaseTag

    A base tag handler class for layout tags.

    A layout tag has to create a specific layout object and pass it to the enclosing container. This base class already handles the latter part, i.e. correctly initializing the hosting container object. A concrete sub class will have to implement the creation of the specific layout object.

    Version:
    $Id: LayoutTag.java 205 2012-01-29 18:29:57Z oheger $
    Author:
    Oliver Heger
    • Constructor Detail

      • LayoutTag

        public LayoutTag()
    • Method Detail

      • process

        protected void process()
                        throws org.apache.commons.jelly.JellyTagException,
                               FormBuilderException
        Executes this tag. This implementation fetches the corresponding container, creates the layout and ensures that it is set in the container.
        Specified by:
        process in class FormBaseTag
        Throws:
        FormBuilderException - if an error occurs
        org.apache.commons.jelly.JellyTagException - if a jelly specific error occurs
      • createLayout

        protected abstract Object createLayout​(ComponentManager manager)
                                        throws FormBuilderException,
                                               org.apache.commons.jelly.JellyTagException
        Creates the specific layout object. This method must be defined in concrete sub classes, it is called by this tag's main execution method.
        Parameters:
        manager - the component manager
        Returns:
        the new layout object
        Throws:
        FormBuilderException - if an error occurs
        org.apache.commons.jelly.JellyTagException - if the tag is incorrectly used