org.apache.ecs.wml.Anchor Maven / Gradle / Ivy

/*
 * ====================================================================
 * 
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights 
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:  
 *       "This product includes software developed by the 
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Jakarta Element Construction Set", 
 *    "Jakarta ECS" , and "Apache Software Foundation" must not be used 
 *    to endorse or promote products derived
 *    from this software without prior written permission. For written 
 *    permission, please contact [email protected].
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Jakarta Element Construction Set" nor "Jakarta ECS" nor may "Apache" 
 *    appear in their names without prior written permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * .
 *
 */
package org.apache.ecs.wml;

import org.apache.ecs.Element;
import org.apache.ecs.MultiPartElement;

/**
    This class implements the anchor element
 
    @author Written by Anders.Samuelson
    @author Modifications by Örjan Petersson
 */
public class Anchor extends org.apache.ecs.MultiPartElement
{

    /**
	Basic constructor. You need to set the attributes using the
	set* methods.
    */
    public Anchor()
    {
	setElementType("anchor");
    }

    
    /**
	This constructor creates a <anchor> tag.
	@param sValue what goes between <start_tag> <end_tag>
	@param eValue what goes between <start_tag> <end_tag>
    */
    public Anchor(String title, Element eValue)
    {
	this();
	setAttrTitle(title);
	addElement(eValue);
    }

    /**
	This constructor creates a <anchor> tag.
	@param title the TITLE="" attribute
	@param sValue what goes between <start_tag> <end_tag>
	@param eValue what goes between <start_tag> <end_tag>
    */
    public Anchor(String title, String sValue, Element eValue)
    {
	this();
	setAttrTitle(title);
	addElement(sValue);
	addElement(eValue);
    }


    /**
	Sets the title="" attribute
	@param title the title="" attribute
    */
    public Anchor setAttrTitle(String title)
    {
	addAttribute("title", title);
	return this;
    }

    /**
	Adds an Element to the element.
	@param  element Adds an Element to the element.
     */
    public Anchor addElement(Element element)
    {
	addElementToRegistry(element,getFilterState());
	return(this);
    }
    
    /**
	Adds an Element to the element.
	@param  element Adds an Element to the element.
     */
    public Anchor addElement(String element)
    {
	addElementToRegistry(element,getFilterState());
	return(this);
    }
}