Package de.uplanet.lucy.server.auxiliaries

Class ListFormatter

java.lang.Object

de.uplanet.lucy.server.auxiliaries.ListFormatter

@VelocityCallable("singleton")
public final class ListFormatter
extends Object

Provides list-formatting functionality for generating client output.

Constructor Summary

Constructors

Constructor	Description
ListFormatter()	Construct a ListFormatter.

Method Summary

Modifier and Type	Method	Description
String	getOptionList(de.uplanet.util.PairArray<String,String> p_list)	Create an option list from a pair-array with the 0th option selected.
String	getOptionList(de.uplanet.util.PairArray<String,String> p_list, int p_iSelectedIndex)	Create an option list from a pair-array with the 0th option selected.
String	getOptionListT(de.uplanet.util.PairArray<String,String> p_list, String p_strSelectedText)	Create an option list from a pair-array with specified option selected.
String	getOptionListV(de.uplanet.util.PairArray<String,String> p_list, String p_strSelectedValue)	Create an option list from a pair-array with specified option selected.
String	getOutputType()	Get the currently selected output type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListFormatter

public ListFormatter()

Construct a ListFormatter.

Method Detail

getOutputType

public String getOutputType()

Get the currently selected output type.

Returns:

The output type.

getOptionList

public String getOptionList(de.uplanet.util.PairArray<String,String> p_list)

Create an option list from a pair-array with the 0th option selected.

Parameters:

p_list - An array containing the value-text-pairs.

Returns:

The option list.

getOptionList

public String getOptionList(de.uplanet.util.PairArray<String,String> p_list,
                            int p_iSelectedIndex)

Create an option list from a pair-array with the 0th option selected.

Parameters:

p_list - An array containing the value-text-pairs.

p_iSelectedIndex - The index of the option that should be selected.

Returns:

The option list.

getOptionListV

public String getOptionListV(de.uplanet.util.PairArray<String,String> p_list,
                             String p_strSelectedValue)

Create an option list from a pair-array with specified option selected.

Parameters:

p_list - An array containing the value-text-pairs.

p_strSelectedValue - The value of the option that should be selected.

Returns:

The option list.

getOptionListT

public String getOptionListT(de.uplanet.util.PairArray<String,String> p_list,
                             String p_strSelectedText)

Create an option list from a pair-array with specified option selected.

Parameters:

p_list - An array containing the value-text-pairs.

p_strSelectedText - The text of the option that should be selected.

Returns:

The option list.