package greenfoot;




| A representation of a Font. The Font can be used to write text on the screen.
|
| @author Fabio Heday
| @author Amjad Altadmri
|
public class Font
{        
private final java.awt.Font font;

   
   


| Creates a Greenfoot font based on a java.awt.Font
|
| @param font
|
Font(java.awt.Font font)
   {        
      this.font = font;     
      }

   
   


| Creates a font from the specified font name, size and style.
|
| @param name The font name
| @param bold True if the font is meant to be bold
| @param italic True if the font is meant to be italic
| @param size The size of the font
|
public Font(String name, boolean bold, boolean italic, int size)
   {        
      int style = java.awt.Font.PLAIN;
      if (bold) {            
         style = java.awt.Font.BOLD;         
         }
      if (italic) {            
         style = style | java.awt.Font.ITALIC;         
         }
       
      this.font = new java.awt.Font(name, style, size);     
      }

   
   


| Creates a sans serif font with the specified size and style.
|
| @param bold True if the font is meant to be bold
| @param italic True if the font is meant to be italic
| @param size The size of the font
|
public Font(boolean bold, boolean italic, int size)
   {
      this("SansSerif", bold, italic, size);     
      }

   
   


| Creates a font from the specified font name and size.
|
| @param name The font name
| @param size The size of the font
|
public Font(String name, int size)
   {
      this(name, false, false, size);     
      }

   
   


| Creates a sans serif font of a given size.
|
| @param size The size of the font
|
public Font(int size)
   {
      this(false, false, size);     
      }

   
   


| Indicates whether or not this Font style is plain.
|
| @return true if this font style is plain; false otherwise
|
public boolean isPlain()
   {
      return this.font.isPlain();     
      }

   
   


| Indicates whether or not this Font style is bold.
|
| @return true if this font style is bold; false otherwise
|
public boolean isBold()
   {
      return this.font.isBold();     
      }

   
   


| Indicates whether or not this Font style is italic.
|
| @return true if this font style is italic; false otherwise
|
public boolean isItalic()
   {
      return this.font.isItalic();     
      }

   
   


| Returns the logical name of this font.
|
| @return a <code>String</code> representing the logical name of this font.
|
public String getName()
   {
      return this.font.getName();     
      }

   
   


| Returns the point size of this font, rounded to an integer.
|
| @return the point size of this font in 1/72 of an inch units.
|
public int getSize()
   {
      return this.font.getSize();     
      }

   
   


| Creates a new <code>Font</code> object by cloning the current
| one and then applying a new size to it.
|
| @param size the size for the new <code>Font</code>.
| @return a new <code>Font</code> object.
|
public Font deriveFont(float size)
   {        
      return new Font(font.deriveFont(size));     
      }

   
   


| Determines whether another object is equal to this font.
|
| @param obj the object to test for equality with this font
| @return true if the fonts are the same; false otherwise.
|
@Override
   
   public boolean equals(Object obj)
   {
      if (obj == this) {            
         return true;         
         }

      return (obj != null) && (obj instanceof Font) && ((Font) obj).getFontObject().equals(this.font);     
      }

   
   


| Returns a hashcode for this font.
|
| @return a hashcode value for this font.
|
@Override
   
   public int hashCode()
   {
      return font.hashCode();     
      }

   
   


| Return a text representation of the font.
| @return Details of the font
|
@Override
   
   public String toString()
   {        
      return "Font{" + "font=" + font + '}';     
      }

   
   


| Return the internal Font object representing the Greenfoot.Font.
|
| @return the java.awt.Font object
|
java.awt.Font getFontObject()
   {        
      return this.font;     
      } 
   }