com.cyclopsgroup.waterview.jelly.deftaglib.FrameTag.java Source code

Introduction

Here is the source code for com.cyclopsgroup.waterview.jelly.deftaglib.FrameTag.java

Source

/* ==========================================================================
 * Copyright 2002-2005 Cyclops Group Community
 * 
 * Licensed under the Open Software License, Version 2.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://opensource.org/licenses/osl-2.1.php
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 * =========================================================================
 */
package com.cyclopsgroup.waterview.jelly.deftaglib;

import org.apache.avalon.framework.service.ServiceManager;
import org.apache.commons.jelly.JellyTagException;
import org.apache.commons.jelly.XMLOutput;
import org.apache.commons.lang.StringUtils;

import com.cyclopsgroup.waterview.Frame;
import com.cyclopsgroup.waterview.ModuleManager;
import com.cyclopsgroup.waterview.jelly.AbstractTag;

/**
 * Frame definition tag
 * 
 * @author <a href="mailto:jiaqi.guo@gmail.com">Jiaqi Guo </a>
 */
public class FrameTag extends AbstractTag {

    private String description;

    private Frame frame;

    private String id;

    /**
     * Override or implement method of parent class or interface
     *
     * @see com.cyclopsgroup.waterview.jelly.AbstractTag#doTag(org.apache.avalon.framework.service.ServiceManager, org.apache.commons.jelly.XMLOutput)
     */
    public void doTag(ServiceManager serviceManager, XMLOutput output) throws Exception {
        requireAttribute("id");
        if (StringUtils.isEmpty(getDescription())) {
            setDescription("Layout [" + getId() + "]");
        }
        invokeBody(output);
        if (getFrame() == null) {
            throw new JellyTagException("There must be a frame defined in layout tag");
        }
        ModuleManager moduleManager = (ModuleManager) serviceManager.lookup(ModuleManager.ROLE);
        moduleManager.registerFrame(getId(), getFrame());
    }

    /**
     * Getter method for description
     *
     * @return Returns the description.
     */
    public String getDescription() {
        return description;
    }

    /**
     * Getter method for frame
     *
     * @return Returns the frame.
     */
    public Frame getFrame() {
        return frame;
    }

    /**
     * Getter method for id
     *
     * @return Returns the id.
     */
    public String getId() {
        return id;
    }

    /**
     * Setter method for description
     *
     * @param description The description to set.
     */
    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * Setter method for frame
     *
     * @param frame The frame to set.
     */
    public void setFrame(Frame frame) {
        this.frame = frame;
    }

    /**
     * Setter method for id
     *
     * @param id The id to set.
     */
    public void setId(String id) {
        this.id = id;
    }
}