Package com.itextpdf.layout.element

Class List

    • Constructor Detail

      • List

        public List​(ListNumberingType listNumberingType)
        Creates a List with a custom numbering type.
        Parameters:
        listNumberingType - a prefix style

    • Method Detail

      • getDefaultProperty

        public <T1> T1 getDefaultProperty​(int property)
        Description copied from interface: IPropertyContainer
        Gets the default property from this entity.
        Specified by:
        getDefaultProperty in interface IPropertyContainer
        Overrides:
        getDefaultProperty in class BlockElement<List>
        Type Parameters:
        T1 - the return type associated with the property
        Parameters:
        property - the property to be retrieved
        Returns:
        the default property value. If the default property is not defined, null will be returned

      • add

        public List add​(ListItem listItem)
        Adds a new ListItem to the bottom of the List.
        Parameters:
        listItem - a new list item
        Returns:
        this list.

      • add

        public List add​(java.lang.String text)
        Adds a new ListItem to the bottom of the List.
        Parameters:
        text - textual contents of the new list item
        Returns:
        this list.

      • setItemStartIndex

        public List setItemStartIndex​(int start)
        Customizes the index of the first item in the list.
        Parameters:
        start - the custom index, as an int
        Returns:
        this list.

      • setListSymbol

        public List setListSymbol​(java.lang.String symbol)
        Sets the list symbol to be used. This will create an unordered list, i.e. all list items will be shown with the same prefix.
        Parameters:
        symbol - the textual symbol to be used for all items.
        Returns:
        this list.

      • setListSymbol

        public List setListSymbol​(Text text)
        Sets the list symbol to be used. This will create an unordered list, i.e. all list items will be shown with the same prefix.
        Parameters:
        text - the Text object to be used for all items.
        Returns:
        this list.

      • setListSymbol

        public List setListSymbol​(Image image)
        Sets the list symbol to be used. This will create an unordered list, i.e. all list items will be shown with the same prefix.
        Parameters:
        image - the Image object to be used for all items.
        Returns:
        this list.

      • setListSymbol

        public List setListSymbol​(ListNumberingType listNumberingType)
        Sets the list numbering type to be used. This will create an ordered list, i.e. every ListItem will have a unique prefix.
        Parameters:
        listNumberingType - the ListNumberingType that will generate appropriate prefixes for the ListItems.
        Returns:
        this list.

      • setListSymbolAlignment

        public List setListSymbolAlignment​(ListSymbolAlignment alignment)
        A specialized enum containing alignment properties for list symbols. ListSymbolAlignment.LEFT means that the items will be aligned as follows: 9. Item 9 10. Item 10

        Whereas ListSymbolAlignment.RIGHT means the items will be aligned as follows: 9. Item 9 10. Item 10

        Parameters:
        alignment - the alignment of the list symbols
        Returns:
        this element

      • getSymbolIndent

        public java.lang.Float getSymbolIndent()
        Gets the indent offset of the ListItem symbols.
        Returns:
        the indent offset as a float.

      • setSymbolIndent

        public List setSymbolIndent​(float symbolIndent)
        Sets the indent offset of the ListItem symbols.
        Parameters:
        symbolIndent - the new indent offset.
        Returns:
        this list.

      • getPostSymbolText

        public java.lang.String getPostSymbolText()
        Gets the piece of text that is added after the ListItem symbol.
        Returns:
        the post symbol text

      • setPostSymbolText

        public void setPostSymbolText​(java.lang.String postSymbolText)
        Sets a piece of text that should be added after the ListItem symbol.
        Parameters:
        postSymbolText - the post symbol text

      • getPreSymbolText

        public java.lang.String getPreSymbolText()
        Gets the piece of text that is added before the ListItem symbol.
        Returns:
        the pre symbol text

      • setPreSymbolText

        public void setPreSymbolText​(java.lang.String preSymbolText)
        Sets a piece of text that should be added before the ListItem symbol.
        Parameters:
        preSymbolText - the pre symbol text