src.com.ibm.as400.util.html.OrderedListItem Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation
Show all versions of jt400 Show documentation
The Open Source version of the IBM Toolbox for Java
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename: OrderedListItem.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 OrderedListItem class represents an item in an ordered list item.
*
* This example creates a OrderedListItem tag:
*
* // Create an OrderedList.
* OrderedList list = new OrderedList(HTMLConstants.CAPITALS);
*
* // Create an OrderedListItem.
* OrderedListItem listItem = new OrderedListItem();
*
* // Set the data in the list item.
* listItem.setItemData(new HTMLText("my list item"));
*
* // Add the list item to the OrderedList.
* list.addListItem(listItem);
* System.out.println(list.toString());
*
*
* Here is the output of the OrderedListItem tag:
*
* <ol type="capitals">
* <li>my list item</li>
* </ol>
*
* Here is the output of the OrderedListItem tag using XSL Formatting Objects:
*
* <fo:block-container>
* <fo:list-block>
* <fo:list-item>
* <fo:list-item-label>A.</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>
*
*
* OrderedListItem objects generate the following events:
*
* - PropertyChangeEvent
*
**/
public class OrderedListItem extends HTMLListItem
{
private static final String copyright = "Copyright (C) 1997-2001 International Business Machines Corporation and others.";
static final long serialVersionUID = -5825465966031878506L;
private String type_; //The labeling scheme used to display the ordered list item
private int value_ = -1; //The number other than the incremented value for the current List Item (LI)
/**
* Constructs a default OrderedListItem object.
**/
public OrderedListItem()
{
super();
}
/**
* Constructs a OrderedListItem object with the specified list item data.
* @param data The data to use in the ordered list item.
**/
public OrderedListItem(HTMLTagElement data)
{
super();
setItemData(data);
}
/**
* Returns the type of the order labeling.
* @return The type.
**/
public String getType()
{
return type_;
}
/**
* Returns the number for the current list item
* @return The number.
**/
public int getValue()
{
return value_;
}
/**
* Returns the type and value attributes.
* @return The attributes.
**/
String getTypeAttribute()
{
//@B1D
StringBuffer s = new StringBuffer("");
if (type_ != null)
{
if (type_.equals(HTMLConstants.NUMBERS))
s.append(" type=\"1\"");
else if (type_.equals(HTMLConstants.CAPITALS))
s.append(" type=\"A\"");
else if (type_.equals(HTMLConstants.LOWER_CASE))
s.append(" type=\"a\"");
else if (type_.equals(HTMLConstants.LARGE_ROMAN))
s.append(" type=\"I\"");
else if (type_.equals(HTMLConstants.SMALL_ROMAN))
s.append(" type=\"i\"");
}
if (value_ > 0)
{
s.append(" value=\"");
s.append(Integer.toString(value_));
s.append("\"");
}
return s.toString();
}
/**
* Returns the label for the XSL-FO list-label.
* @return The label.
**/
String getTypeAttributeFO(String type, int label) //@C1A
{
if(value_ > 0)
{
label = value_;
}
StringBuffer s = new StringBuffer("");
if (type != null)
{
if (type.equals(HTMLConstants.NUMBERS))
{
s.append(String.valueOf(label));
s.append(".");
}
else if (type.equals(HTMLConstants.CAPITALS))
{
char c = (char)(64 + label);
s.append(c);
s.append(".");
}
else if (type.equals(HTMLConstants.LOWER_CASE))
{
char c = (char)(96 + label);
s.append(c);
s.append(".");
}
else if (type.equals(HTMLConstants.LARGE_ROMAN))
{
s.append(toRoman(label));
s.append(".");
}
else if (type.equals(HTMLConstants.SMALL_ROMAN))
{
s.append(toRoman(label).toLowerCase());
s.append(".");
}
}
return s.toString();
}
/**
* Returns a number's Roman numeral equivalent.
* @param n The number to get the roman numeral for.
* @return The roman numeral.
**/
String toRoman(int n) //@C1A
{
StringBuffer numeral=new StringBuffer(20);
while (n >= 1000)
{
numeral.append("M");
n -= 1000;
}
if (n >= 900)
{
numeral.append("CM");
n -= 900;
}
if (n >= 500)
{
numeral.append("D");
n -= 500;
}
if (n >= 400)
{
numeral.append("CD");
n -= 400;
}
while (n >= 100)
{
numeral.append("C");
n -= 100;
}
if (n >= 90)
{
numeral.append("XC");
n -= 90;
}
if (n >= 50)
{
numeral.append("L");
n -= 50;
}
if (n >= 40)
{
numeral.append("XL");
n -= 40;
}
while (n >= 10)
{
numeral.append("X");
n -= 10;
}
if (n >= 9)
{
numeral.append("IX");
n -= 9;
}
if (n >= 5)
{
numeral.append("V");
n -= 5;
}
if (n >= 4)
{
numeral.append("IV");
n -= 4;
}
while (n >= 1)
{
numeral.append("I");
n -= 1;
}
return numeral.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 order labeling to be used. The default order is by number, (1, 2, 3, etc.).
*
* @param type The order labeling scheme. One of the following constants
* defined in HTMLConstants: NUMBERS, CAPITALS, LOWER_CASE, LARGE_ROMAN, or SMALL_ROMAN.
*
* @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.NUMBERS)) && !(type.equals(HTMLConstants.CAPITALS))
&& !(type.equals(HTMLConstants.LOWER_CASE)) && !(type.equals(HTMLConstants.LARGE_ROMAN))
&& !(type.equals(HTMLConstants.SMALL_ROMAN)) )
{
throw new ExtendedIllegalArgumentException("type", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
if (Trace.isTraceOn())
Trace.log(Trace.INFORMATION, " Setting order labeling type for .");
String old = type_;
type_ = type;
if (changes_ != null) changes_.firePropertyChange("type", old, type ); //@CRS
}
/**
* Sets a number other than the incremented value for the current List Item (LI) in an Ordered List (OL.) It is
* thus possible to create a non-sequential list. Values are automatically converted to the TYPE attribute, if present,
* of the parent OL element or current LI element. The number value must be a positive integer.
*
* @param value The ordered list item value.
*
**/
public void setValue(int value)
{
if (value < 0)
throw new ExtendedIllegalArgumentException("value", ExtendedIllegalArgumentException.RANGE_NOT_VALID);
if (Trace.isTraceOn())
Trace.log(Trace.INFORMATION, " Setting current - number for
.");
int old = value_;
value_ = value;
if (changes_ != null) changes_.firePropertyChange("value", new Integer(old), new Integer(value) ); //@CRS
}
}