org.wings.template.TemplateTagHandler 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.Reader;
import java.util.Map;

import org.wings.SComponent;
import org.wings.STemplateLayout;
import org.wings.io.Device;
import org.wings.template.parser.ParseContext;
import org.wings.template.parser.SpecialTagHandler;

/**
 * A TemplateTagHandler
 *
 * @author Henner Zeller
 */
abstract class TemplateTagHandler implements SpecialTagHandler {
    long startPos;
    long endPos;
    Map properties;
    String name;

    /**
     * Get start position of the area in the sourcefile this
     * handler processes.
     */
    @Override
    public long getTagStart() {
        return startPos;
    }

    /**
     * Get the length of the area in the sourcefile.
     * The area this handler processes is skipped in the inputfile.
     */
    /*
     * Since we just have a single tag, this is just the area
     * this tag spans:
     */
    @Override
    public long getTagLength() {
        return endPos - startPos;
    }

    /**
     * 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 {
        TemplateParseContext tcontext = (TemplateParseContext) context;
        Device sink = tcontext.getDevice();

        /*
         * get the component that is associtated with this name. This has
         * been set as Layout Manager Constraint.
         */
        SComponent c = tcontext.getComponent(name);
        if (c == null) {
            sink.print("");
        } else {
            // set properties; the STemplateLayout knows how
            if (properties.size() > 0) {
                PropertyManager propManager =
                        STemplateLayout.getPropertyManager(c.getClass());

                if (propManager != null) {
                    for (Object o : properties.keySet()) {
                        String key = (String) o;
                        String value = (String) properties.get(key);
                        // System.out.println("set Property " + key + "=" +value + "  for " + name);
                        propManager.setProperty(c, key, value);
                    }
                }
            }
            c.write(sink);
        }
        input.skip(getTagLength());
    }
}