Source for javax.swing.text.html.ListView

   1: /* ListView.java -- 
   2:    Copyright (C) 2006 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: package javax.swing.text.html;
  39: 
  40: import java.awt.Graphics;
  41: import java.awt.Rectangle;
  42: import java.awt.Shape;
  43: 
  44: import javax.swing.text.Element;
  45: 
  46: /**
  47:  * A View to render HTML lists, like the <code>&lt;ul&gt;</code> and
  48:  * <code>&lt;ol&gt;</code> tags.
  49:  *
  50:  * @author Roman Kennke (kennke@aicas.com)
  51:  */
  52: public class ListView
  53:   extends BlockView
  54: {
  55: 
  56:   /**
  57:    * The painter used to paint the list items.
  58:    */
  59:   private StyleSheet.ListPainter painter;
  60: 
  61:   /**
  62:    * Creates a new <code>ListView</code> for the specified element.
  63:    *
  64:    * @param el the element to create a list view for
  65:    */
  66:   public ListView(Element el)
  67:   {
  68:     super(el, Y_AXIS);
  69:   }
  70: 
  71:   /**
  72:    * Returns the alignment of this view along the specified axis.
  73:    *
  74:    * This returns <code>0.5</code> unconditionally.
  75:    *
  76:    * @param axis the axis
  77:    *
  78:    * @return the alignment of this view along the specified axis
  79:    */
  80:   public float getAlignment(int axis)
  81:   {
  82:     if (axis != X_AXIS && axis != Y_AXIS)
  83:       throw new IllegalArgumentException("Illegal axis parameter: " + axis);
  84: 
  85:     return 0.5F;
  86:   }
  87: 
  88:   /**
  89:    * Paints the <code>ListView</code>.
  90:    *
  91:    * @param g the graphics context to use for painting
  92:    * @param allocation the allocation given to this view
  93:    */
  94:   public void paint(Graphics g, Shape allocation)
  95:   {
  96:     super.paint(g, allocation);
  97:   }
  98: 
  99:   /**
 100:    * Paints the child with the specified index into the specified allocation.
 101:    *
 102:    * This implementation forwards to the list painter fetched from the
 103:    * {@link StyleSheet} and then calls
 104:    * <code>super.paintChild(g, a, index)</code>.
 105:    *
 106:    * @param g the graphics context to use
 107:    * @param a the allocation for the child
 108:    * @param index the child index
 109:    */
 110:   protected void paintChild(Graphics g, Rectangle a, int index)
 111:   {
 112:     painter.paint(g, a.x, a.y, a.width, a.height, this, index);
 113:     super.paintChild(g, a, index);
 114:   }
 115: 
 116:   /**
 117:    * Fetches this view's properties from the style attributes of this view's
 118:    * element.
 119:    *
 120:    * This forwards to super and then fetches a {@link StyleSheet.ListPainter}
 121:    * from the stylesheet suitable for painting the list.
 122:    */
 123:   protected void setPropertiesFromAttributes()
 124:   {
 125:     super.setPropertiesFromAttributes();
 126:     painter = getStyleSheet().getListPainter(getAttributes());
 127:   }
 128: }