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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation
The Open Source version of the IBM Toolbox for Java
There is a newer version: 20.0.8
///////////////////////////////////////////////////////////////////////////////
//                                                                             
// JTOpen (IBM Toolbox for Java - OSS version)                                 
//                                                                             
// Filename: HTMLMeta.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.Trace;
import com.ibm.as400.access.ExtendedIllegalStateException;
import com.ibm.as400.access.ExtendedIllegalArgumentException;

import java.beans.PropertyChangeSupport;
import java.beans.PropertyChangeListener;


/**
*  The HTMLMeta class represents meta-information used within an HTMLHead tag.
*  This meta information can be used in identifying, indexing, and defining
*  information within the HTML document.
*  
*  This example creates an HTMLMeta tag:
*  
*  // Create an HTMLMeta.
*  HTMLMeta meta = new HTMLMeta("Expires", "Mon, 01 Jun 2000 12:00:00 CST");
*  System.out.println(header);
*  
*  
*  Here is the output of the HTMLMeta tag:

*  
*  <meta http-equiv="Expires" content="Mon, 01 Jun 2000 12:00:00 CST" />
*  
*
*  HTMLMeta objects generate the following events:
*  

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

    private String content_;
    private String name_;
    private String HttpEquiv_;
    private String url_;

    private String lang_;        // The primary language used to display the tags contents.  
    private String dir_;         // The direction of the text interpretation.                



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


    /**
    *  Constructs an HTMLMeta object with the specified meta HTTP-EQUIV and content.
    *
    *  @param HttpEquiv The HTTP-EQUIV meta information.
    *  @param content  The value of a named property.
    **/
    public HTMLMeta(String HttpEquiv, String content)
    {
        super();

        setHttpEquiv(HttpEquiv);
        setContent(content);
    }


    /**
    *  Constructs an HTMLMeta object with the specified meta HTTP-EQUIV, content, and URL.
    *
    *  @param HttpEquiv The HTTP-EQUIV meta information.
    *  @param content  The value of a named property.
    *  @param url The URL to reload after the time specified in the content attribute.
    **/
    public HTMLMeta(String HttpEquiv, String content, String url)
    {
        super();

        setHttpEquiv(HttpEquiv);
        setContent(content);
        setUrl(url);
    }



    /**
    *  Returns the content of the HTMLMeta tag.
    *  @return The value of a named property.
    **/
    public String getContent()                               
    {
        return content_;
    }


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


    /**
    *  Returns the direction attribute tag.
    *  @return The direction tag.
    **/
    String getDirectionAttributeTag()                                                 
    {
        //@C1D

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


    /**
    *  Returns the HTTP-EQUIV of the meta tag.
    *  @return The HTTP-EQUIV meta information.
    **/
    public String getHttpEquiv()                               
    {
        return HttpEquiv_;
    }


    /**
    *  Returns the language of the meta tag.
    *  @return The language of the meta tag.
    **/
    public String getLanguage()                                
    {
        return lang_;
    }


    /**
    *  Returns the language attribute tag.                                            
    *  @return The language tag.                                                      
    **/                                                                               
    String getLanguageAttributeTag()                                                  
    {
        //@C1D

        if ((lang_ != null) && (lang_.length() > 0))
            return " lang=\"" + lang_ + "\"";
        else
            return "";
    }


    /**
    *  Returns the name of the meta tag.
    *  @return The name of a property.
    **/
    public String getName()                                
    {
        return name_;
    }


    /**
    *  Returns the URL of the meta tag.
    *  @return The URL to reload.
    **/
    public String getUrl()                                
    {
        return url_;
    }


    /**
    *  Returns the tag for the HTML heading.
    *  @return The tag.
    **/
    public String getTag()
    {
        //@C1D

        if (content_ == null)
        {
            Trace.log(Trace.ERROR, "Attempting to get tag before setting meta content.");
            throw new ExtendedIllegalStateException(
                                                   "content", ExtendedIllegalStateException.PROPERTY_NOT_SET );
        }

        if (name_ == null && HttpEquiv_ == null)
        {
            Trace.log(Trace.ERROR, "Attempting to get tag before setting name or http-equiv attributes.");
            throw new ExtendedIllegalStateException("name/HttpEquiv", ExtendedIllegalStateException.PROPERTY_NOT_SET);
        }


        StringBuffer s = new StringBuffer("\n");

        return s.toString();
    }


    /**
    *  Returns a comment tag.
    *  This method should not be called.  There is no XSL-FO support for this class.
    *  @return The comment tag.
    **/
    public String getFOTag()                                                //@D1A
    {
        Trace.log(Trace.ERROR, "Attempting to getFOTag() for an object that doesn't support it.");
        return "";
    }

    /**
    *  Deserializes and initializes transient data.
    **/
    private void readObject(java.io.ObjectInputStream in)          
    throws java.io.IOException, ClassNotFoundException
    {
        in.defaultReadObject();
        //@CRS changes_ = new PropertyChangeSupport(this);
    }



    /**
    *  Sets the content of the meta information.
    *  @param content The value for a named property.
    **/
    public void setContent(String content)                                     
    {
        if (content == null)
            throw new NullPointerException("content");

        String old = content_;

        content_ = content;

        if (changes_ != null) changes_.firePropertyChange("content", old, content ); //@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
    **/
    public void setDirection(String dir)                                     
    {
        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_;

        dir_ = dir;

        if (changes_ != null) changes_.firePropertyChange("dir", old, dir ); //@CRS
    }


    /**
    *  Sets the HTTP-EQUIV of the meta tag.
    *
    *  @param HttpEquiv The HTTP-EQUIV meta information.
    **/
    public void setHttpEquiv(String HttpEquiv)                                     
    {
        if (HttpEquiv == null)
            throw new NullPointerException("HttpEquiv");

        String old = HttpEquiv_;

        HttpEquiv_ = HttpEquiv;

        if (changes_ != null) changes_.firePropertyChange("HttpEquiv", old, HttpEquiv ); //@CRS
    }


    /**
    *  Sets the language of the meta tag.
    *
    *  @param lang The language.  Example language tags include:
    *  en and en-US.
    **/
    public void setLanguage(String lang)                                      
    {
        if (lang == null)
            throw new NullPointerException("lang");

        String old = lang_;

        lang_ = lang;

        if (changes_ != null) changes_.firePropertyChange("lang", old, lang ); //@CRS
    }


    /**
    *  Sets the name of the meta tag.  If the name is
    *  not set, it is assumed to be the same as the value of
    *  the HTTP-EQUIV.
    *
    *  @param name The name of a property.
    **/
    public void setName(String name)                                      
    {
        if (name == null)
            throw new NullPointerException("name");

        String old = name_;

        name_ = name;

        if (changes_ != null) changes_.firePropertyChange("name", old, name ); //@CRS
    }


    /**
    *  Sets the URL to reload after the time specified 
    *  in the content attribute.
    *
    *  @param url The URL to reload.
    **/
    public void setUrl(String url)                                      
    {
        if (url == null)
            throw new NullPointerException("url");

        String old = url_;

        url_ = url;

        if (changes_ != null) changes_.firePropertyChange("url", old, url ); //@CRS
    }


    /**
    *  Returns a String representation for the HTMLMeta tag.
    *  @return The tag.
    **/
    public String toString()
    {
        return getTag();
    }
}