de.vandermeer.asciilist

Class DescriptionListItem

Object

AbstractAsciiListItem

DescriptionListItem

All Implemented Interfaces:

AsciiListItem

public class DescriptionListItem
extends AbstractAsciiListItem

Implementation of AsciiListItem for a description list.

Since:

v0.0.2

Version:

v0.0.3 build 160301 (01-Mar-16) for Java 1.7

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	term The term of a description.

Fields inherited from class AbstractAsciiListItem

content

Constructor Summary

Constructors

Constructor and Description
DescriptionListItem(Object term, Object description) Creates a new description item with term and description.

Method Summary

Modifier and Type	Method and Description
Object	getTerm() Returns the term of the description item.
String	render(int preLabelIndent, String preLabelStr, String postLabelStr, int postLabelIndent, boolean singleLine) Renders the list item, generates a string representation of it.

Methods inherited from class AbstractAsciiListItem

getContent, render

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

term

protected final Object term

The term of a description.

Constructor Detail

DescriptionListItem

public DescriptionListItem(Object term,
                           Object description)

Creates a new description item with term and description.

Parameters:

term - the description term

description - the term description

Method Detail

render

public String render(int preLabelIndent,
                     String preLabelStr,
                     String postLabelStr,
                     int postLabelIndent,
                     boolean singleLine)

Renders the list item, generates a string representation of it.

Parameters:

preLabelIndent - indentation before the label (and before the pre-label string)

preLabelStr - a string to be printed after pre-indentation but before the label

postLabelStr - a string to be printed right after the label but before the post-indentation

postLabelIndent - indentation after the post-label string (before the actual item content)

singleLine - flag to render for single line (true) or multiline (false)

Returns:

rendered list item

getTerm

public Object getTerm()

Returns the term of the description item.

Returns:

term