Anchor.java

/**
 * Anchor.java
 * (c) Peter Bielik and Radek Burget, 2011-2012
 *
 * SwingBox 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 3 of the License, or
 * (at your option) any later version.
 *  
 * SwingBox is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *  
 * You should have received a copy of the GNU Lesser General Public License
 * along with SwingBox. If not, see <http://www.gnu.org/licenses/>.
 * 
 */

package org.fit.cssbox.swingbox.util;

import java.util.HashMap;
import java.util.Map;

import org.w3c.dom.Node;

/**
 * The Class Anchor. Provides info about hyperlinks.
 * 
 * @author Peter Bielik
 * @version 1.0
 * @since 1.0 - 4.5.2011
 */
public class Anchor
{
    // a helper object for hyperlinks
    private boolean active;
    private Map<String, String> properties;

    /**
     * Instantiates a new anchor.
     * 
     * @param activity
     *            is it really a link ?
     * @param props
     *            the properties
     */
    public Anchor(boolean activity, Map<String, String> props)
    {
        this.active = activity;
        properties = new HashMap<String, String>(props);
    }

    /**
     * Instantiates a new anchor.
     */
    public Anchor()
    {
        properties = new HashMap<String, String>();
        active = false;
    }

    /**
     * Checks if is active.
     * 
     * @return true, if is a real link
     */
    public boolean isActive()
    {
        return active;
    }

    /**
     * Sets the activity.
     * 
     * @param active
     *            if true, is a link
     */
    public void setActive(boolean active)
    {
        this.active = active;
    }

    /**
     * Gets the properties.
     * 
     * @return the properties
     */
    public Map<String, String> getProperties()
    {
        return properties;
    }

    /**
     * Equal properties.
     * 
     * @param other
     *            the other
     * @return true, if successful
     */
    public boolean equalProperties(Map<String, String> other)
    {
        return properties.equals(other);
    }

    @Override
    public String toString()
    {
        return "Anchor(@" + Integer.toHexString(hashCode()) + ")[Active: "
                + active + ", Properties: " + properties.toString() + "]";
    }
    
    /**
     * Examines the given element and all its parent elements in order to find the "a" element.
     * @param e the child element to start with
     * @return the "a" element found or null if it is not present
     */
    public static org.w3c.dom.Element findAnchorElement(org.w3c.dom.Element e)
    {
        if ("a".equalsIgnoreCase(e.getTagName().trim()))
            return e;
        else if (e.getParentNode() != null && e.getParentNode().getNodeType() == Node.ELEMENT_NODE)
            return findAnchorElement((org.w3c.dom.Element) e.getParentNode());
        else
            return null;
    }

}