/* TagElement.java --
   Copyright (C) 2005 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath 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
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package javax.swing.text.html.parser;

import javax.swing.text.html.HTML;

/**
 * The SGML element, defining a single html tag.
 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
 */
public class TagElement
{
  /**
   * The Element the tag was constructed from.
   */
  private final Element element;

  /**
   * The coresponding HTML tag, assigned once in constructor.
   */
  private final HTML.Tag tag;

  /**
   * The 'fictional' flag.
   */
  private final boolean fictional;

  /**
   * Creates the html tag element from the defintion, stored in the
   * given element. Sets the flag 'fictional' to false.
   * @param an_element
   */
  public TagElement(Element an_element)
  {
    this(an_element, false);
  }

  /**
   * Creates the html tag element from the defintion, stored in the
   * given element, setting the flag 'fictional' to the given value.
   */
  public TagElement(Element an_element, boolean is_fictional)
  {
    element = an_element;
    fictional = is_fictional;

    HTML.Tag t = HTML.getTag(element.getName());

    if (t != null)
      tag = t;
    else
      tag = new HTML.UnknownTag(element.getName());
  }

  /**
   * Get the element from that the tag was constructed.
   */
  public Element getElement()
  {
    return element;
  }

  /**
   * Get the corresponding HTML tag. This is either one of the
   * pre-defined HTML tags or the instance of the UnknownTag with the
   * element name.
   */
  public HTML.Tag getHTMLTag()
  {
    return tag;
  }

  /**
   * Calls isPreformatted() for the corresponding html tag and returns
   * the obtained value.
   */
  public boolean isPreformatted()
  {
    return tag.isPreformatted();
  }

  /**
   * Calls breaksFlow() for the corresponding html tag and returns
   * the obtained value.
   */
  public boolean breaksFlow()
  {
    return tag.breaksFlow();
  }

  /**
   * Get the value of the flag 'fictional'.
   */
  public boolean fictional()
  {
    return fictional;
  }

  /**
   * Returns string representation of this object.
   */
  public String toString()
  {
    return getElement() + (fictional ? "?" : "");
  }
}
