com.ibm.as400.util.html

Class HTMLList

  • All Implemented Interfaces:
    HTMLTagElement, java.io.Serializable
    Direct Known Subclasses:
    OrderedList, UnorderedList


    public abstract class HTMLList
    extends HTMLTagAttributes
    implements java.io.Serializable
    The HTMLList class represents a list. The list can either be an ordered list <ol> or an unordered list <ul>.

    HTMLList objects generate the following events:

    • ElementEvent - The events fired are:
      • elementAdded
      • elementRemoved
    • PropertyChangeEvent
    See Also:
    Serialized Form
    • Constructor Detail

      • HTMLList

        public HTMLList()
        Constructs a default HTMLList object.
      • HTMLList

        public HTMLList(java.util.Vector itemList)
        Constructs an HTMLList object with the specified itemList.
        Parameters:
        itemList - The items in the HTMLList.
    >
    • Method Detail

      • addListItem

        public void addListItem(HTMLListItem item)
        Adds an HTMLListItem item to the HTMLList.
        Parameters:
        item - The HTMLTagElement.
      • addList

        public void addList(HTMLList list)
        Adds an HTML list to the HTMLList.
        Parameters:
        list - The HTMLList.
      • addListItemElementListener

        public void addListItemElementListener(ElementListener listener)
        Adds an ElementListener.
        Parameters:
        listener - The ElementListener.
      • getDirection

        public java.lang.String getDirection()
        Returns the direction of the text interpretation.
        Returns:
        The direction of the text.
      • getItemCount

        public int getItemCount()
        Returns the number of items in the HTMLList.
        Returns:
        The number of items.
      • getItems

        public java.util.Vector getItems()
        Returns the list of items.
        Returns:
        The items.
      • getLanguage

        public java.lang.String getLanguage()
        Returns the language of the input element.
        Returns:
        The language of the input element.
      • isCompact

        public boolean isCompact()
        Indicates if the list is initialized to compact.
        Returns:
        true if compact; false otherwise.
      • isUseFO

        public boolean isUseFO()
        Returns if Formatting Object tags are outputted. The default value is false.
        Returns:
        true if the output generated is an XSL formatting object, false if the output generated is HTML.
      • removeListItem

        public void removeListItem(HTMLListItem item)
        Removes an HTMLListItem item from the HTMLList.
        Parameters:
        item - The HTMLTagElement.
      • removeList

        public void removeList(HTMLList list)
        Removes an HTML list from the HTMLList.
        Parameters:
        list - The HTMLList.
      • removeListItemElementListener

        public void removeListItemElementListener(ElementListener listener)
        Removes this ElementListener.
        Parameters:
        listener - The ElementListener.
      • setCompact

        public void setCompact(boolean compact)
        Sets whether the list is initialized to being compact. The compact attribute instructs the browser to reduce the space occupied by the list.
        Parameters:
        compact - true if initialized to compact; false otherwise. The default is false.
      • setDirection

        public void setDirection(java.lang.String dir)
        Sets the direction of the text interpretation.
        Parameters:
        dir - The direction. One of the following constants defined in HTMLConstants: LTR or RTL.
        See Also:
        HTMLConstants
      • setItems

        public void setItems(java.util.Vector itemList)
        Sets the items in the HTMLList.
        Parameters:
        itemList - The list of items.
      • setLanguage

        public void setLanguage(java.lang.String lang)
        Sets the language of the input tag.
        Parameters:
        lang - The language. Example language tags include: en and en-US.
      • setUseFO

        public void setUseFO(boolean useFO)
        Sets if Formatting Object tags should be used. The default value is false.
        Parameters:
        useFO - - true if output generated is an XSL formatting object, false if the output generated is HTML.
      • toString

        public java.lang.String toString()
        Returns a String representation for the HTMLList tag.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The tag.