001/* ListView.java --
002   Copyright (C) 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.swing.text.html;
039
040import java.awt.Graphics;
041import java.awt.Rectangle;
042import java.awt.Shape;
043
044import javax.swing.text.Element;
045
046/**
047 * A View to render HTML lists, like the <code>&lt;ul&gt;</code> and
048 * <code>&lt;ol&gt;</code> tags.
049 *
050 * @author Roman Kennke (kennke@aicas.com)
051 */
052public class ListView
053  extends BlockView
054{
055
056  /**
057   * The painter used to paint the list items.
058   */
059  private StyleSheet.ListPainter painter;
060
061  /**
062   * Creates a new <code>ListView</code> for the specified element.
063   *
064   * @param el the element to create a list view for
065   */
066  public ListView(Element el)
067  {
068    super(el, Y_AXIS);
069  }
070
071  /**
072   * Returns the alignment of this view along the specified axis.
073   *
074   * This returns <code>0.5</code> unconditionally.
075   *
076   * @param axis the axis
077   *
078   * @return the alignment of this view along the specified axis
079   */
080  public float getAlignment(int axis)
081  {
082    if (axis != X_AXIS && axis != Y_AXIS)
083      throw new IllegalArgumentException("Illegal axis parameter: " + axis);
084
085    return 0.5F;
086  }
087
088  /**
089   * Paints the <code>ListView</code>.
090   *
091   * @param g the graphics context to use for painting
092   * @param allocation the allocation given to this view
093   */
094  public void paint(Graphics g, Shape allocation)
095  {
096    super.paint(g, allocation);
097  }
098
099  /**
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}