org.wings.template.RangeTagHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wings Show documentation
The newest version!
/*
 * Copyright 2000,2005 wingS development team.
 *
 * This file is part of wingS (http://wingsframework.org).
 *
 * wingS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * Please see COPYING for the complete licence.
 */
package org.wings.template;

import java.io.IOException;
import java.io.Reader;

import org.wings.io.Device;
import org.wings.template.parser.ParseContext;
import org.wings.template.parser.PositionReader;
import org.wings.template.parser.SGMLTag;

/**
 * A TemplateTagHandler
 *
 * @author Henner Zeller
 */
public class RangeTagHandler extends TemplateTagHandler {
    boolean close_is_missing = false;

    /**
     * Parse special tag.
     *
     * @param context  The ParseContext
     * @param input    The PositionReader, located after the Name token of the Tag
     * @param startPosition The Position parsing of this token began
     * @param startTag the SGMLTag found in the file.
     */
    @Override
    public SGMLTag parseTag(ParseContext context,
                            PositionReader input,
                            long startPosition,
                            SGMLTag startTag)
            throws IOException
    {
        final String startTagName = startTag.getName();

        /*
         * parse the full tag to get all parameters
         * (i.e. an optional 'format'-parameter)
         * and to place the Reader at the position
         * after the closing '>'
         */
        startTag.parse(input);

        /*
         * The Offset is the space the reader skipped
         * before it reached the opening '<'
         *    some garbage 
         * ^----- offset --------------------^
         */
        startPos = startPosition + startTag.getOffset();

        /*
         * get properties
         */
        properties = startTag.getAttributes();

        name = startTag.value("NAME", null);
        if (name == null)
            return null;

        context.addContainedComponent(name);

        endPos = input.getPosition();  // in case  is missing

        final String endTagName = "/" + startTagName;
        while (!startTag.finished()) {
            startTag = new SGMLTag(input, true);
            if (startTag.isNamed(endTagName) || startTag.isNamed(startTagName))
                break;
        }

        // Either EOF or newly opened COMPONENT (unexpectedly)
        if (startTag.finished() || startTag.isNamed(startTagName)) {
            close_is_missing = true;
        } else {
            // The current Position is after the closing '>'
            endPos = input.getPosition();
        }

        // remove properties, which are not necessary for the PropertyManager
        properties.remove("NAME");
        properties.remove("TYPE");
        context.setProperties(name, properties);

        return startTag;
    }

    /**
     * actually perform the action associated with this tag.
     *
     * @throws Exception anything can happen .. and throw an Exception
     *                   which is caught in PageParser
     */
    @Override
    public void executeTag(ParseContext context, Reader input)
            throws Exception {
        super.executeTag(context, input);

        // warn, if the closing tag was not found ..
        if (close_is_missing) {
            TemplateParseContext tcontext = (TemplateParseContext) context;
            Device sink = tcontext.getDevice();
            sink.print("");
            sink.print(" ");
            sink.print("closing tag missing");
            sink.print(" for '" + name + "'");
            sink.print(" ");
            sink.print("");
        }
    }
}