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

src.com.ibm.as400.util.html.HTMLText Maven / Gradle / Ivy

Go to download

The Open Source version of the IBM Toolbox for Java

There is a newer version: 11.1
Show newest version
///////////////////////////////////////////////////////////////////////////////
//                                                                             
// JTOpen (IBM Toolbox for Java - OSS version)                                 
//                                                                             
// Filename: HTMLText.java
//                                                                             
// The source code contained herein is licensed under the IBM Public License   
// Version 1.0, which has been approved by the Open Source Initiative.         
// Copyright (C) 1997-2001 International Business Machines Corporation and     
// others. All rights reserved.                                                
//                                                                             
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.util.html;

import com.ibm.as400.access.ExtendedIllegalArgumentException;
import com.ibm.as400.access.ExtendedIllegalStateException;
import com.ibm.as400.access.Trace;

import java.awt.Color;
import java.beans.PropertyChangeSupport;
import java.beans.PropertyChangeListener;
import java.beans.PropertyVetoException;
import java.beans.VetoableChangeSupport;
import java.beans.VetoableChangeListener;
import java.io.Serializable;
/**
*  The HTMLText class encapsulates HTML text attributes.
*
*  
This example creates an HTMLText object and sets its attributes.
*  
*  
*  HTMLText text = new HTMLText("IBM");
*  text.setBold(true);
*  text.setSize(3);
*  System.out.println(text.getTag());
*  

*
*  Here is the output of the tag:
*  
*  <font size="3"><b>IBM</b></font>
*  

*  

*  Here is the output of calling getFOTag():
*  
*  <fo:block font-size='9pt' font-weight='bold'>IBM</fo:block>
*  

*
*  
HTMLText objects generate the following events:
*  
    
*  
  • PropertyChangeEvent
*  
  • VetoableChangeEvent
*  

**/
public class HTMLText extends HTMLTagAttributes implements HTMLConstants, Serializable      // @Z1C
{
  private static final String copyright = "Copyright (C) 1997-2001 International Business Machines Corporation and others.";
  static final long serialVersionUID = 8640694441108878894L;

    private String text_;                    // The text to tag.   
    private String alignment_;               // The horizontal alignment.  "left", "center", "right" or "justify".
    private Color color_;                     // The font color attribute.
    private int size_ = 0;                   // The font size attribute.  
    private boolean bold_ = false;           // The bold style attribute.
    private boolean fixed_ = false;          // The fixed pitch style attribute.
    private boolean italic_ = false;         // The italic style attribute.
    private boolean underscore_ = false;     // The underline style attribute.

    private String lang_;        // The primary language used to display the tags contents.  //$B1A
    private String dir_;         // The direction of the text interpretation.                //$B1A
    private boolean useFO_;      // Indicates if XSL-FO tags are outputted.                  //@D1A

    transient private VetoableChangeSupport vetos_; //@CRS

    /**
    *  Constructs a default HTMLText object.
    **/
    public HTMLText()
    {
        super();
    }

    /**
    *  Constructs an HTMLText object with the specified text.
    *  @param text The text.
    **/
    public HTMLText(String text)
    {
        this();

        try
        {
            setText(text);   
        }
        catch (PropertyVetoException e)
        { /* do nothing */
        }
    }



    /**
    *  Adds the VetoableChangeListener.  The specified VetoableChangeListener's vetoableChange 
    *  method is called each time the value of any constrained property is changed.
    *  @see #removeVetoableChangeListener
    *  @param listener The VetoableChangeListener.
    **/
    public void addVetoableChangeListener(VetoableChangeListener listener)
    {
        if (listener == null)
            throw new NullPointerException("listener");
        if (vetos_ == null) vetos_ = new VetoableChangeSupport(this); //@CRS
        vetos_.addVetoableChangeListener(listener);
    }

    /**
    *  Returns the horizontal alignment.
    *  @return The horizontal alignment.  One of the following constants
    *  defined in HTMLConstants:  LEFT, CENTER, RIGHT, or JUSTIFY.
    *  @see com.ibm.as400.util.html.HTMLConstants
    **/
    public String getAlignment()
    {
        return alignment_;
    }


    /**
    *  Returns the color used to paint the text.
    *  @return The Color object representing the text color.
    **/
    public Color getColor()              // @A1
    {
        return color_;
    }


    /**
     *  Returns the direction of the text interpretation.
     *  @return The direction of the text.
     **/
    public String getDirection()                               //$B1A
    {
        return dir_;
    }


    /**
    *  Returns the direction attribute tag.
    *  @return The direction tag.
    **/
    String getDirectionAttributeTag()                                                 //$B1A
    {
        if(useFO_ )                                                                      //@D1A
        {                                                                                //@D1A
            if((dir_ != null) && (dir_.length()>0))                                      //@D1A
            {                                                                            //@D1A
                if(dir_.equals(HTMLConstants.RTL))                                       //@D1A
                    return " writing-mode='rl'";                                         //@D1A
                else                                                                     //@D1A
                    return " writing-mode='lr'";                                         //@D1A
            }                                                                            //@D1A
            else                                                                         //@D1A
                return "";                                                               //@D1A
        }                                                                                //@D1A
        else                                                                             //@D1A
        {                                                                                //@D1A
            //@C1D

           if ((dir_ != null) && (dir_.length() > 0))
                return " dir=\"" + dir_ + "\"";
            else
                return "";
        }                                                                                //@D1A
    }


    /**
   *  Returns the end text alignment tag.
   *  @return The end text alignment tag or an empty String
   *  if the alignment is not set.
   **/
    String getEndTextAlignmentTag()
    {
        if (alignment_ != null)
            return("
"); else return ""; } /** * Returns the end font tag. * @Return The end font size tag or an empty String * if the size is not set. **/ String getEndTextFontTag() { if (size_ != 0 || color_ != null || getAttributeString().length() != 0) { return(""); } else { return ""; } } /** * Returns the end tags for the text styles. * The tags are bold, italic, underline, and fixed. * @return The end text style tag string or an empty String * if the style attributes are not set. **/ String getEndTextStyleTag() { StringBuffer tag = new StringBuffer(); if (fixed_) { if( !useFO_ ) //@D1A tag.append(""); } if (underscore_) { if( !useFO_ ) //@D1A tag.append(""); else //@D1A tag.append("\n"); //@D1A } if (italic_) { if( !useFO_ ) //@D1A tag.append(""); } if (bold_) { if( !useFO_ ) //@D1A tag.append(""); } return tag.toString(); //@D1C } /** * Returns the font color attribute. * @return The font color attribute or an empty String if the color is not set. **/ String getFontColorAttribute() // @A1 { //@C1D StringBuffer colorBuffer = new StringBuffer(""); if (color_ != null) { colorBuffer.append(" color=\"#"); String rgb = Integer.toHexString(color_.getRGB()); colorBuffer.append(rgb.substring(2)); // don't want 0xff at beginning of RGB string. colorBuffer.append("\""); } return new String(colorBuffer); } /** * Returns the font size attribute. * @Return The font size attribute or an empty String * if the size is not set. **/ String getFontSizeAttribute() { //@C1D StringBuffer tag = new StringBuffer(""); if (size_ != 0) { if(!useFO_ ) //@D1A { tag.append(" size=\""); tag.append(size_); tag.append("\""); } else { //@D1A tag.append(" font-size='"); tag.append(size_*3); tag.append("pt'"); } } return tag.toString(); //@D1C } /** * Returns the language of the text element. * @return The language of the input element. **/ public String getLanguage() //$B1A { return lang_; } /** * Returns the language attribute tag. * @return The language tag. **/ String getLanguageAttributeTag() //$B1A { //@C1D if ((lang_ != null) && (lang_.length() > 0)) return " lang=\"" + lang_ + "\""; else return ""; } /** * Returns the font text size. * The default value is 0 (browser default). * @return The font size. **/ public int getSize() { return size_; } /** * Returns the text tag. The alignment tag is not included. * @return The tag. **/ public String getTag() { return getTag(text_, false); } /** * Returns the XSL-FO text tag. The alignment tag is not included. * @return The tag. **/ public String getFOTag() { //@D1A return getFOTag(text_, false); } /** * Returns the text tag. * @param useAlignment true if the alignment tag should be included; false otherwise. * @return The tag. **/ public String getTag(boolean useAlignment) { return getTag(text_, useAlignment); } /** * Returns the XSL-FO text tag. * @param useAlignment true if the alignment tag should be included; false otherwise. * @return The tag. **/ public String getFOTag(boolean useAlignment) { //@D1A return getFOTag(text_, useAlignment); } /** * Returns the text tag with the specified text. * The alignment tag is not included. * @param text The text. * @return The tag. **/ public String getTag(String text) { return getTag(text, false); } /** * Returns the XSL-FO text tag with the specified text. * The alignment tag is not included. * @param text The text. * @return The tag. **/ public String getFOTag(String text) { //@D1A return getFOTag(text, false); } /** * Returns the text tag with the specified text. * @param text The text. * @param useAlignment true if the alignment tag should be included; false otherwise. * @return The tag. **/ public String getTag(String text, boolean useAlignment) { //@C1D if(useFO_) //@D1A return getFOTag(text, useAlignment); //@D1A if (text == null) throw new NullPointerException("text"); StringBuffer tag = new StringBuffer(); if (useAlignment) tag.append(getTextAlignmentTag()); tag.append(getTextFontTag()); // if a BiDirectional attribute has been set, add the //$B1A // bdo tag to the html text string. //$B1A if (lang_ != null || dir_ != null) //$B1A { tag.append("\n\n"); //$B1A tag.append(getTextStyleTag()); //$B1A tag.append(text); //$B1A tag.append(getEndTextStyleTag()); //$B1A tag.append("\n\n"); //$B1A } else //$B1A { tag.append(getTextStyleTag()); tag.append(text); tag.append(getEndTextStyleTag()); } tag.append(getEndTextFontTag()); if (useAlignment) tag.append(getEndTextAlignmentTag()); return tag.toString(); //@D1C } /** * Returns the XSL-FO text tag with the specified text. * The fixed pitch and language attributes are not supported by XSL-FO. * @param text The text. * @param useAlignment true if the alignment tag should be included; false otherwise. * @return The tag. **/ public String getFOTag(String text, boolean useAlignment) //@D1A { //Save current state of useFO_ boolean useFO = useFO_; setUseFO(true); if (text == null) throw new NullPointerException("text"); StringBuffer tag = new StringBuffer(); if (dir_ != null) { tag.append("\n"); } tag.append(""); tag.append(text); tag.append(getEndTextStyleTag()); tag.append("\n"); if (dir_ != null) { tag.append("\n"); } //Set useFO_ to previous state setUseFO(useFO); return tag.toString(); } /** * Returns the text. * @return The text. **/ public String getText() { return text_; } /** * Returns the text alignment tag. * @return The text alignment tag or an empty String * if the alignment is not set. **/ String getTextAlignmentTag() { if(!useFO_ ) //@D1A { //@D1A //@C1D if (alignment_ != null) { StringBuffer tag = new StringBuffer(); tag.append("
"); return tag.toString(); //@D1C } else return ""; } //@D1A else { //@D1A if (alignment_!= null) { StringBuffer tag = new StringBuffer(); tag.append(" text-align='"); if(alignment_.equals("center")) tag.append("center'"); else if(alignment_.equals("right")) tag.append("end'"); else if(alignment_.equals("left")) tag.append("start'"); else if(alignment_.equals("justify")) tag.append("justify'"); return tag.toString(); } else return ""; } } /** * Returns the font attribute tag. * @return The font attribute tag or an empty String if the font attributes are not set. **/ String getTextFontTag() // @A1 { StringBuffer tag = new StringBuffer(""); String extraAttributes = getAttributeString(); // @Z1A if (size_ != 0 || color_ != null || extraAttributes.length() != 0) // @Z1C { if( !useFO_ ) //@D1A { tag.append(""); } //@D1A else { //@D1A tag.append(getFontSizeAttribute()); tag.append(getFontColorAttribute()); } } return tag.toString(); //@D1C } /** * Returns the text style tags. The tags are * bold, italic, underline, and fixed. * @return The text style tag string or an empty String * if the style attributes are not set. **/ String getTextStyleTag() { //@C1D StringBuffer tag = new StringBuffer(); if (bold_) { if(!useFO_) //@D1A tag.append(""); else //@D1A tag.append(" font-weight='bold'"); //@d1 } if (italic_) { if(!useFO_ ) //@D1A tag.append(""); else //@D1A tag.append(" font-style='italic'"); //@D1A } if (underscore_) { if(!useFO_) //@D1A tag.append(""); else //@D1A tag.append(">\n"); } return tag.toString(); //@D1C } /** * Indicates if bold is on. * @return true if bold, false otherwise. **/ public boolean isBold() { return bold_; } /** * Indicates if fixed pitch font is on. * @return true if fixed, false otherwise. **/ public boolean isFixed() { return fixed_; } /** * Indicates if italic is on. * @return true if italic, false otherwise. **/ public boolean isItalic() { return italic_; } /** * Indicates if underline is on. * @return true if underline, false otherwise. **/ public boolean isUnderscore() { return underscore_; } /** * Returns if Formatting Object tags are outputted. * The default value is false. * @return true if the output generated is an XSL formatting object, false if the output generated is HTML. **/ public boolean isUseFO() //@D1A { return useFO_; } /** * Deserializes and initializes transient data. **/ private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, ClassNotFoundException { in.defaultReadObject(); //@CRS changes_ = new PropertyChangeSupport(this); //@CRS vetos_ = new VetoableChangeSupport(this); } /** * Removes the VetoableChangeListener from the internal list. * If the VetoableChangeListener is not on the list, nothing is done. * @see #addVetoableChangeListener * @param listener The VetoableChangeListener. **/ public void removeVetoableChangeListener(VetoableChangeListener listener) { if (listener == null) throw new NullPointerException("listener"); if (vetos_ != null) vetos_.removeVetoableChangeListener(listener); //@CRS } /** * Sets the horizontal alignment. * @param alignment The horizontal alignment. One of the following constants * defined in HTMLConstants: LEFT, CENTER, RIGHT, or JUSTIFY. * @exception PropertyVetoException If the change is vetoed. * @see com.ibm.as400.util.html.HTMLConstants **/ public void setAlignment(String alignment) throws PropertyVetoException { if (alignment == null) { throw new NullPointerException("alignment"); } else if (alignment.equalsIgnoreCase(LEFT) || alignment.equalsIgnoreCase(CENTER) || alignment.equalsIgnoreCase(RIGHT) || alignment.equalsIgnoreCase(JUSTIFY)) { String old = alignment_; if (vetos_ != null) vetos_.fireVetoableChange("alignment", old, alignment ); //@CRS alignment_ = alignment; if (changes_ != null) changes_.firePropertyChange("alignment", old, alignment ); //@CRS } else { throw new ExtendedIllegalArgumentException("alignment", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID); } } /** * Sets bold on or off. The default is false. * @param bold true if on, false if off. * @exception PropertyVetoException If the change is vetoed. **/ public void setBold(boolean bold) throws PropertyVetoException { //@CRS Boolean oldBold = new Boolean(bold_); //@CRS Boolean newBold = new Boolean(bold); boolean oldBold = bold_; //@CRS if (vetos_ != null) vetos_.fireVetoableChange("bold", new Boolean(oldBold), new Boolean(bold)); //@CRS bold_ = bold; if (changes_ != null) changes_.firePropertyChange("bold", new Boolean(oldBold), new Boolean(bold)); //@CRS } /** * Sets the color used to paint the text. * The default text color is determined by the browser's color settings. * How the color is rendered is browser dependent. * @param color The Color object. * @exception PropertyVetoException If the change is vetoed. **/ public void setColor(Color color) throws PropertyVetoException // @A1 { Color oldColor = color_; if (vetos_ != null) vetos_.fireVetoableChange("color", oldColor, color); //@CRS color_ = color; if (changes_ != null) changes_.firePropertyChange("color", oldColor, color); //@CRS } /** * Sets the direction of the text interpretation. * @param dir The direction. One of the following constants * defined in HTMLConstants: LTR or RTL. * * @see com.ibm.as400.util.html.HTMLConstants * * @exception PropertyVetoException If a change is vetoed. **/ public void setDirection(String dir) //$B1A throws PropertyVetoException { if (dir == null) throw new NullPointerException("dir"); // If direction is not one of the valid HTMLConstants, throw an exception. if ( !(dir.equals(HTMLConstants.LTR)) && !(dir.equals(HTMLConstants.RTL)) ) { throw new ExtendedIllegalArgumentException("dir", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID); } String old = dir_; if (vetos_ != null) vetos_.fireVetoableChange("dir", old, dir ); //@CRS dir_ = dir; if (changes_ != null) changes_.firePropertyChange("dir", old, dir ); //@CRS } /** * Sets fixed pitch font on or off. The default is false. * @param fixed true if on, false if off. * @exception PropertyVetoException If the change is vetoed. **/ public void setFixed(boolean fixed) throws PropertyVetoException { //@CRS Boolean oldFixed = new Boolean(fixed_); //@CRS Boolean newFixed = new Boolean(fixed); boolean oldFixed = fixed_; //@CRS if (vetos_ != null) vetos_.fireVetoableChange("fixed", new Boolean(oldFixed), new Boolean(fixed)); //@CRS fixed_ = fixed; if (changes_ != null) changes_.firePropertyChange("fixed", new Boolean(oldFixed), new Boolean(fixed)); //@CRS } /** * Sets italic on or off. The default is false. * @param italic true if on, false if off. * @exception PropertyVetoException If the change is vetoed. **/ public void setItalic(boolean italic) throws PropertyVetoException { //@CRS Boolean oldItalic = new Boolean(italic_); //@CRS Boolean newItalic = new Boolean(italic); boolean oldItalic = italic_; //@CRS if (vetos_ != null) vetos_.fireVetoableChange("italic", new Boolean(oldItalic), new Boolean(italic)); //@CRS italic_ = italic; if (changes_ != null) changes_.firePropertyChange("italic", new Boolean(oldItalic), new Boolean(italic)); //@CRS } /** * Sets the language of the text tag. * @param lang The language. Example language tags include: * en and en-US. * * @exception PropertyVetoException If a change is vetoed. **/ public void setLanguage(String lang) //$B1A throws PropertyVetoException { if (lang == null) throw new NullPointerException("lang"); String old = lang_; if (vetos_ != null) vetos_.fireVetoableChange("lang", old, lang ); //@CRS lang_ = lang; if (changes_ != null) changes_.firePropertyChange("lang", old, lang ); //@CRS } /** * Sets the text font size. Valid values are: 0 to 7. * The default value is 0 (use browser default). * @param size The font size. * @exception PropertyVetoException If the change is vetoed. **/ public void setSize(int size) throws PropertyVetoException { if (size < 0 || size > 7) throw new ExtendedIllegalArgumentException("size", ExtendedIllegalArgumentException.RANGE_NOT_VALID); //@CRS Integer oldSize = new Integer(size_); //@CRS Integer newSize = new Integer(size); int oldSize = size_; //@CRS if (vetos_ != null) vetos_.fireVetoableChange("size", new Integer(oldSize), new Integer(size) ); //@CRS size_ = size; if (changes_ != null) changes_.firePropertyChange("size", new Integer(oldSize), new Integer(size) ); //@CRS } /** * Sets the text. * @param text The text. * @exception PropertyVetoException If the change is vetoed. **/ public void setText(String text) throws PropertyVetoException { if (text == null) throw new NullPointerException("text"); String old = text_; if (vetos_ != null) vetos_.fireVetoableChange("text", old, text ); //@CRS text_ = text; if (changes_ != null) changes_.firePropertyChange("text", old, text ); //@CRS } /** * Sets underline on or off. The default is false. * @param underscore true if on, false if off. * @exception PropertyVetoException If the change is vetoed. **/ public void setUnderscore(boolean underscore) throws PropertyVetoException { //@CRS Boolean oldUnderscore = new Boolean(underscore_); //@CRS Boolean newUnderscore = new Boolean(underscore); boolean oldUnderscore = underscore_; //@CRS if (vetos_ != null) vetos_.fireVetoableChange("underscore", new Boolean(oldUnderscore), new Boolean(underscore)); //@CRS underscore_ = underscore; if (changes_ != null) changes_.firePropertyChange("underscore", new Boolean(oldUnderscore), new Boolean(underscore)); //@CRS } /** * Sets if Formatting Object tags should be used. * The default value is false. * @param useFO - true if output generated is an XSL formatting object, false if the output generated is HTML. **/ public void setUseFO(boolean useFO) //@D1A { boolean old = useFO_; useFO_ = useFO; if (changes_ != null) changes_.firePropertyChange("useFO", old, useFO ); } /** * Returns the HTML text tag. * @return The tag. **/ public String toString() { return getTag(); } }



© 2015 - 2024 Weber Informatics LLC | Privacy Policy