All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.havi.ui.HStaticText Maven / Gradle / Ivy

Go to download 

package org.havi.ui;

/*
 * Copyright 2000-2003 by HAVi, Inc. Java is a trademark of Sun
 * Microsystems, Inc. All rights reserved.  
 */

import java.awt.Color;
import java.awt.Font;


/**
   The {@link org.havi.ui.HStaticText HStaticText} is a user interface
   component used to display static read-only textual content which
   does not permit the user to navigate (focus) upon it. By
   default it uses the {@link org.havi.ui.HTextLook HTextLook} to render
   itself.

  

  The parameters to the constructors are as follows, in cases where
  parameters are not used, then the constructor should use the default
  values.
  

  
Default parameter values exposed in the constructors

  

  
ParameterDescriptionDefault value 
  Set methodGet method

  

  x
  x-coordinate of top left hand corner of this component in pixels, 
  relative to its parent container (subject to layout management).
  ---
  java.awt.Component#setBounds
  java.awt.Component#getBounds
  

  

  y
  y-coordinate of top left hand corner of this component in pixels,
  relative to its parent container (subject to layout management).
  ---
  java.awt.Component#setBounds
  java.awt.Component#getBounds
  

  

  width
  width of this component in pixels (subject to layout management). 
  
  ---
  java.awt.Component#setBounds
  java.awt.Component#getBounds
  

  

  height
  height of this component in pixels (subject to layout management). 
  
  ---
  java.awt.Component#setBounds
  java.awt.Component#getBounds
  


  


 
    textNormal
    The string to be used as the content for the {@link
    org.havi.ui.HState#NORMAL_STATE HState.NORMAL_STATE} state of this
    component.
    null
    {@link org.havi.ui.HVisible#setTextContent setTextContent}
    {@link org.havi.ui.HVisible#getTextContent getTextContent}


   

        tlm 
        The text layout manager responsible for text
       formatting.
        An {@link org.havi.ui.HDefaultTextLayoutManager
       HDefaultTextLayoutManager} object.
        {@link org.havi.ui.HVisible#setTextLayoutManager
       setTextLayoutManager}
        {@link org.havi.ui.HVisible#getTextLayoutManager
       getTextLayoutManager}
   


   

       font
       The font for this component.
       --- 
       java.awt.Component#setFont
       java.awt.Component#getFont
   


   

       background 
       The background color for this component.
       --- 
       java.awt.Component#getBackground
       java.awt.Component#setBackground
   


   

       foreground 
       The foreground color for this component.
       --- 
       java.awt.Component#getForeground
       java.awt.Component#setForeground
   


  


  
Default parameter values not exposed in the constructors

  

  
DescriptionDefault valueSet method
  Get method

  
 
  Associated matte ({@link org.havi.ui.HMatte HMatte}). 
  none (i.e. getMatte() returns null) 
  {@link org.havi.ui.HComponent#setMatte setMatte} 
  {@link org.havi.ui.HComponent#getMatte getMatte} 
  

   

        The text layout manager responsible for text
       formatting.
        An {@link org.havi.ui.HDefaultTextLayoutManager}
       object.
        {@link org.havi.ui.HVisible#setTextLayoutManager}
       
        {@link org.havi.ui.HVisible#getTextLayoutManager}
       
   


   

       The background painting mode
       {@link org.havi.ui.HVisible#NO_BACKGROUND_FILL}

       {@link org.havi.ui.HVisible#setBackgroundMode}
       {@link org.havi.ui.HVisible#getBackgroundMode}
   


   

       The default preferred size
       not set (i.e. NO_DEFAULT_SIZE) unless specified by width
       and height parameters
       {@link org.havi.ui.HVisible#setDefaultSize}
       {@link org.havi.ui.HVisible#getDefaultSize}
   


   

       The horizontal content alignment
       {@link org.havi.ui.HVisible#HALIGN_CENTER}
       {@link org.havi.ui.HVisible#setHorizontalAlignment}
       {@link org.havi.ui.HVisible#getHorizontalAlignment}
   


   

       The vertical content alignment
       {@link org.havi.ui.HVisible#VALIGN_CENTER}
       {@link org.havi.ui.HVisible#setVerticalAlignment}
       {@link org.havi.ui.HVisible#getVerticalAlignment}
   


   

       The content scaling mode
       {@link org.havi.ui.HVisible#RESIZE_NONE}
       {@link org.havi.ui.HVisible#setResizeMode}
       {@link org.havi.ui.HVisible#getResizeMode}
   




    The border mode
    true
    {@link org.havi.ui.HVisible#setBordersEnabled}
    {@link org.havi.ui.HVisible#getBordersEnabled}








  The default "look" for this class.
  A platform specific {@link org.havi.ui.HTextLook HTextLook}
  {@link org.havi.ui.HStaticText#setDefaultLook HStaticText.setDefaultLook}
  {@link org.havi.ui.HStaticText#getDefaultLook HStaticText.getDefaultLook}





  The "look" for this object.
  The {@link org.havi.ui.HTextLook HTextLook} returned from
  HStaticText.getDefaultLook when this object was created.
  {@link org.havi.ui.HStaticText#setLook HStaticText.setLook}
  {@link org.havi.ui.HStaticText#getLook HStaticText.getLook}


  


  @see HDefaultTextLayoutManager
  @see HTextLayoutManager

*/

public class HStaticText 
    extends HVisible 
    implements HNoInputPreferred
{
    /**
     * Creates an {@link org.havi.ui.HStaticText HStaticText}
     * object. See the class description for details of constructor
     * parameters and default values. For constructors which specify 
     * content as parameters, see 'State-based content' in HVisible for 
     * unspecified content associated with other HStates. 
     */
    public HStaticText()
    {
    }

    /**
     * Creates an {@link org.havi.ui.HStaticText HStaticText}
     * object. See the class description for details of constructor
     * parameters and default values. For constructors which specify 
     * content as parameters, see 'State-based content' in HVisible for 
     * unspecified content associated with other HStates. 
     */
    public HStaticText(String textNormal, int x, int y, int width, int height)
    {
    }

    /**
     * Creates an {@link org.havi.ui.HStaticText HStaticText}
     * object. See the class description for details of constructor
     * parameters and default values. For constructors which specify 
     * content as parameters, see 'State-based content' in HVisible for 
     * unspecified content associated with other HStates. 
     */
    public HStaticText(String textNormal, int x, int y, int width, int height,
		       Font font, Color foreground, Color background, 
		       HTextLayoutManager tlm)
    {
    }

    /**
     * Creates an {@link org.havi.ui.HStaticText HStaticText}
     * object. See the class description for details of constructor
     * parameters and default values. For constructors which specify 
     * content as parameters, see 'State-based content' in HVisible for 
     * unspecified content associated with other HStates. 
     */
    public HStaticText(String textNormal)
    {
    }

    /**
     * Creates an {@link org.havi.ui.HStaticText HStaticText}
     * object. See the class description for details of constructor
     * parameters and default values. For constructors which specify 
     * content as parameters, see 'State-based content' in HVisible for 
     * unspecified content associated with other HStates. 
     */
    public HStaticText(String textNormal, Font font, Color foreground, 
		       Color background, HTextLayoutManager tlm)
    {
    }

    /**
     * Sets the {@link org.havi.ui.HLook HLook} for this component.
     * 
     * @param hlook The {@link org.havi.ui.HLook HLook} that is to be
     * used for this component.
     * Note that this parameter may be null, in which case the
     * component will not draw itself until a look is set.
     * @exception HInvalidLookException if the Look is not an {@link
     * org.havi.ui.HTextLook HTextLook}.  
     */
    public void setLook(HLook hlook) 
	throws HInvalidLookException
    {
    }

    /**
     * Sets the default {@link org.havi.ui.HLook HLook} for further
     * {@link org.havi.ui.HStaticText HStaticText} Components.
     * 
     * @param hlook The {@link org.havi.ui.HLook HLook} that will be
     * used by default when creating a new {@link
     * org.havi.ui.HStaticText HStaticText} component.
     * Note that this parameter may be null, in which case newly
     * created components shall not draw themselves until a non-null
     * look is set using the {@link
     * org.havi.ui.HStaticText#setLook setLook} method.
     */
    public static void setDefaultLook(HTextLook hlook) 
    {
    }

    /**
     * Returns the currently set default {@link org.havi.ui.HLook
     * HLook} for {@link org.havi.ui.HStaticText HStaticText}
     * components.
     * 
     * @return The {@link org.havi.ui.HLook HLook} that is used by
     * default when creating a new {@link org.havi.ui.HStaticText
     * HStaticText} component.  
     */
    public static HTextLook getDefaultLook()
    {
        return (null);
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy