com.ibm.as400.util.html.UnorderedList 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: UnorderedList.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;



/**
*  The UnorderedList class represents an HTML unordered list, <ul>.
*  
*  This example creates a UnorderedList tag:
*  
*  // Create an UnorderedList.
*  UnorderedList list = new UnorderedList();
*  
*  // Use circles when displaying the list items.
*  list.setType(HTMLConstants.CIRCLE);
*  
*  // Create an UnorderedListItem.
*  UnorderedListItem listItem = new UnorderedListItem();
*  
*  // Set the data in the list item.
*  listItem.setItemData(new HTMLText("my list item"));
*  
*  // Add the list item to the UnorderedList.
*  list.addListItem(listItem);
*  System.out.println(list.toString());
*  
*  
*  Here is the output of the UnorderedList tag:

*  
*  <ul type="circle">
*  <li>my list item</li>
*  </ul>
*  
*  Here is the output of the UnorderedList tag using XSL-Formatting Objects:
*  
*  <fo:block-container>
*  <fo:list-block>
*  <fo:list-item>
*  <fo:list-item-label>&#202;</fo:list-item-label>
*  <fo:list-item-body><fo:block-container><fo:block>my list item</fo:block>
*  </fo:block-container>
*  </fo:list-item-body>
*  </fo:list-item>
*  </fo:list-block>
*  </fo:block-container>
*  
*
*  UnorderedList objects generate the following events:
*  

*    PropertyChangeEvent
*  
**/
public class UnorderedList extends HTMLList
{
  private static final String copyright = "Copyright (C) 1997-2001 International Business Machines Corporation and others.";
  static final long serialVersionUID = -8234261579413831795L;


    private String type_;       //The labeling scheme used to display the list .


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


    /**
    *  Constructs a UnorderedList object with the specified labeling type.
    *  @param type The labeling scheme used to display the list.  One of the following 
    *  constants defined in HTMLConstants:  DISC, SQUARE, or CIRCLE.
    **/
    public UnorderedList(String type)
    {
        super();

        setType(type);
    }


    /**
    *  Returns the attribute tag.
    *  @return The tag.
    **/
    private String getTypeAttributeTag()
    {
        //@C1D

        StringBuffer s = new StringBuffer("");

        if (type_ != null)
        {
            if (type_.equals(HTMLConstants.DISC))
                s.append(" type=\"disc\"");
            else if (type_.equals(HTMLConstants.SQUARE))
                s.append(" type=\"square\"");
            else if (type_.equals(HTMLConstants.CIRCLE))
                s.append(" type=\"circle\"");

            return s.toString();
        }
        else
            return "";

    }


    /**
    *  Returns the type of the labeling scheme.
    *  @return The type.
    **/
    public String getType()
    {
        return type_;
    }


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

        if(isUseFO())                      //@D1A
            return getFOTag();          //@D1A

        if (getItems().isEmpty())
        {
            Trace.log(Trace.ERROR, "Attempting to get tag before setting items in list.");
            throw new ExtendedIllegalStateException(
                                                   "items", ExtendedIllegalStateException.PROPERTY_NOT_SET );
        }

        StringBuffer s = new StringBuffer("\n");
        s.append(getItemAttributeTag());
        s.append("\n");

        return s.toString();
    }


    /**
    *  Returns the XSL-FO tag for the unordered list.
    *  @return The tag.
    **/
    public String getFOTag()                //@D1A
    {
        //Save current state of useFO_
        boolean useFO = isUseFO();

        setUseFO(true);
        if (getItems().isEmpty())
        {
            Trace.log(Trace.ERROR, "Attempting to get XSL-FO tag before setting items in list.");
            throw new ExtendedIllegalStateException(
                                                   "items", ExtendedIllegalStateException.PROPERTY_NOT_SET );
        }

        if(type_ == null)
            type_ = HTMLConstants.DISC;
        StringBuffer s = new StringBuffer("\n");
        s.append("\n");
        s.append(getItemAttributeFOTag(type_));
        s.append("\n");
        s.append("\n");
        
        //Set useFO_ to previous state
        setUseFO(useFO);
        
        return s.toString();
    }


    /**
    *  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 labeling scheme to be used.  The default scheme is disc.
     *
     *  @param type The labeling scheme.  One of the following constants
     *  defined in HTMLConstants:  DISC, SQUARE, or CIRCLE.
     *
     *  @see com.ibm.as400.util.html.HTMLConstants
     **/
    public void setType(String type)
    {
        if (type == null)
            throw new NullPointerException("type");

        // If type is not one of the valid HTMLConstants, throw an exception.
        if ( !(type.equals(HTMLConstants.DISC))  && !(type.equals(HTMLConstants.CIRCLE)) && !(type.equals(HTMLConstants.SQUARE)) )
        {
            throw new ExtendedIllegalArgumentException("type", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
        }

        //@CRS if (Trace.isTraceOn())
        //@CRS    Trace.log(Trace.INFORMATION, "   Setting labeling type for .");

        String old = type_;

        type_ = type;

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

}