Source for javax.swing.text.html.parser.TagElement

   1: /* TagElement.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.swing.text.html.parser;
  40: 
  41: import javax.swing.text.html.HTML;
  42: 
  43: /**
  44:  * The SGML element, defining a single html tag.
  45:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  46:  */
  47: public class TagElement
  48: {
  49:   /**
  50:    * The Element the tag was constructed from.
  51:    */
  52:   private final Element element;
  53: 
  54:   /**
  55:    * The coresponding HTML tag, assigned once in constructor.
  56:    */
  57:   private final HTML.Tag tag;
  58: 
  59:   /**
  60:    * The 'fictional' flag.
  61:    */
  62:   private final boolean fictional;
  63: 
  64:   /**
  65:    * Creates the html tag element from the defintion, stored in the
  66:    * given element. Sets the flag 'fictional' to false.
  67:    * @param an_element
  68:    */
  69:   public TagElement(Element an_element)
  70:   {
  71:     this(an_element, false);
  72:   }
  73: 
  74:   /**
  75:    * Creates the html tag element from the defintion, stored in the
  76:    * given element, setting the flag 'fictional' to the given value.
  77:    */
  78:   public TagElement(Element an_element, boolean is_fictional)
  79:   {
  80:     element = an_element;
  81:     fictional = is_fictional;
  82: 
  83:     HTML.Tag t = HTML.getTag(element.getName());
  84: 
  85:     if (t != null)
  86:       tag = t;
  87:     else
  88:       tag = new HTML.UnknownTag(element.getName());
  89:   }
  90: 
  91:   /**
  92:    * Get the element from that the tag was constructed.
  93:    */
  94:   public Element getElement()
  95:   {
  96:     return element;
  97:   }
  98: 
  99:   /**
 100:    * Get the corresponding HTML tag. This is either one of the
 101:    * pre-defined HTML tags or the instance of the UnknownTag with the
 102:    * element name.
 103:    */
 104:   public HTML.Tag getHTMLTag()
 105:   {
 106:     return tag;
 107:   }
 108: 
 109:   /**
 110:    * Calls isPreformatted() for the corresponding html tag and returns
 111:    * the obtained value.
 112:    */
 113:   public boolean isPreformatted()
 114:   {
 115:     return tag.isPreformatted();
 116:   }
 117: 
 118:   /**
 119:    * Calls breaksFlow() for the corresponding html tag and returns
 120:    * the obtained value.
 121:    */
 122:   public boolean breaksFlow()
 123:   {
 124:     return tag.breaksFlow();
 125:   }
 126: 
 127:   /**
 128:    * Get the value of the flag 'fictional'.
 129:    */
 130:   public boolean fictional()
 131:   {
 132:     return fictional;
 133:   }
 134: 
 135:   /**
 136:    * Returns string representation of this object.
 137:    */
 138:   public String toString()
 139:   {
 140:     return getElement() + (fictional ? "?" : "");
 141:   }
 142: }