libjava/javax/swing/JLabel.java

   1 /* JLabel.java --
   2    Copyright (C) 2002 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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;
  40
  41 import java.awt.Component;
  42 import java.awt.Image;
  43 import javax.accessibility.Accessible;
  44 import javax.accessibility.AccessibleContext;
  45 import javax.swing.plaf.LabelUI;
  46
  47 public class JLabel extends JComponent implements Accessible, SwingConstants
  48 {
  49     String text;
  50     Icon icon;
  51     int gap;
  52     int align;
  53
  54     int hor_align;
  55     int hor_text_pos;
  56
  57     int vert_align;
  58     int vert_text_pos;
  59
  60     public JLabel()
  61     {
  62         this("", null, 0);
  63     }
  64
  65     public JLabel(Icon image)
  66     {
  67         this("", image, 0);
  68     }
  69
  70     public JLabel(Icon image, int horizontalAlignment)
  71     {
  72         this("", image, horizontalAlignment);
  73     }
  74
  75     public JLabel(String text)
  76     {
  77         this(text, null, 0);
  78     }
  79
  80     public JLabel(String text, int horizontalAlignment)
  81     {
  82         this(text, null, horizontalAlignment);
  83     }
  84
  85     public JLabel(String text, Icon icon, int horizontalAlignment)
  86     {
  87         // do the work.....
  88         this.text = text;
  89         setIcon(icon);
  90         this.align     = horizontalAlignment;
  91
  92         updateUI(); // get a proper ui
  93     }
  94
  95
  96     protected  int checkHorizontalKey(int key, String message)
  97     {
  98         //    Verify that key is a legal value for the horizontalAlignment properties.
  99         return 0;
 100     }
 101     protected  int checkVerticalKey(int key, String message)
 102     {
 103         //      Verify that key is a legal value for the verticalAlignment or verticalTextPosition properties.
 104         return 0;
 105     }
 106     public AccessibleContext getAccessibleContext()
 107     {
 108         //          Get the AccessibleContext of this object
 109         return null;
 110     }
 111     public Icon getDisabledIcon()
 112     {
 113         //          Returns the value of the disabledIcon property if it's been set, If it hasn't been set and the value of the icon property is an ImageIcon, we compute a "grayed out" version of the icon and update the disabledIcon property with that.
 114         return null;
 115     }
 116     public int getDisplayedMnemonic()
 117     {
 118         //          Return the keycode that indicates a mnemonic key.
 119         return 0;
 120     }
 121     public int getHorizontalAlignment()
 122     {
 123         //          Returns the alignment of the label's contents along the X axis.
 124         return hor_align;
 125     }
 126     public int getHorizontalTextPosition()
 127     {
 128         //          Returns the horizontal position of the label's text, relative to its image.
 129         return hor_text_pos;
 130     }
 131
 132     public Icon getIcon()
 133     {   return icon;    }
 134
 135     public int getIconTextGap()
 136     {
 137         //          Returns the amount of space between the text and the icon displayed in this label.
 138         return 0;
 139     }
 140     public Component getLabelFor()
 141     {
 142         //          Get the component this is labelling.
 143         return null;
 144     }
 145     public String getText()
 146     {   return text;    }
 147
 148     public String getUIClassID()
 149     {   return "JLabel";    }
 150
 151     public int getVerticalAlignment()
 152     {
 153         //          Returns the alignment of the label's contents along the Y axis.
 154         return vert_align;
 155     }
 156     public int getVerticalTextPosition()
 157     {
 158         //          Returns the vertical position of the label's text, relative to its image.
 159         return vert_text_pos;
 160     }
 161
 162     public boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h)
 163     {
 164         //          This is overriden to return false if the current Icon's Image is not equal to the passed in Image img.
 165         return (img == icon);
 166     }
 167     protected  String paramString()
 168     {
 169         //          Returns a string representation of this JLabel.
 170         return "JLabel";
 171     }
 172     public void setDisabledIcon(Icon disabledIcon)
 173     {
 174         //          Set the icon to be displayed if this JLabel is "disabled" (JLabel.setEnabled(false)).
 175     }
 176     public void setDisplayedMnemonic(char aChar)
 177     {
 178         //          Specifies the displayedMnemonic as a char value.
 179     }
 180     public void setDisplayedMnemonic(int key)
 181     {
 182         //          Specify a keycode that indicates a mnemonic key.
 183     }
 184     public void setHorizontalAlignment(int alignment)
 185     {
 186         //          Sets the alignment of the label's contents along the X axis.
 187         hor_align = alignment;
 188     }
 189     public void setHorizontalTextPosition(int textPosition)
 190     {
 191         //          Sets the horizontal position of the label's text, relative to its image.
 192         hor_text_pos = textPosition;
 193     }
 194     public void setIcon(Icon icon)
 195     {
 196         this.icon = icon;
 197         if (icon != null)
 198             {
 199                   // XXX FIXME - icons do not know their parent
 200 //              icon.setParent(this);
 201             }
 202         revalidate();
 203         repaint();
 204     }
 205
 206     public void setIconTextGap(int iconTextGap)
 207     {
 208         gap = iconTextGap;
 209     }
 210
 211     public void setLabelFor(Component c)
 212     {
 213         //          Set the component this is labelling.
 214     }
 215     public void setText(String text)
 216     {
 217         this.text = text;
 218         revalidate();
 219         repaint();
 220     }
 221
 222     public void setVerticalAlignment(int alignment)
 223     {
 224         //          Sets the alignment of the label's contents along the Y axis.
 225         vert_align = alignment;
 226     }
 227     public void setVerticalTextPosition(int textPosition)
 228     {
 229         //          Sets the vertical position of the label's text, relative to its image.
 230         vert_text_pos = textPosition;
 231     }
 232     public void updateUI()
 233     {
 234         LabelUI b = (LabelUI)UIManager.getUI(this);
 235         setUI(b);
 236     }
 237 }