de.uplanet.lucy.server.auxiliaries
Class ListFormatter

java.lang.Object
  extended by de.uplanet.lucy.server.auxiliaries.ListFormatter

@VelocityCallable(value="singleton")
public final class ListFormatter
extends java.lang.Object

Provides list-formatting functionality for generating client output.

Version:
$Revision: 64100 $

Constructor Summary
ListFormatter()
          Construct a ListFormatter.
 
Method Summary
 java.lang.String getOptionList(de.uplanet.util.PairArray<java.lang.String,java.lang.String> p_list)
          Create an option list from a pair-array with the 0th option selected.
 java.lang.String getOptionList(de.uplanet.util.PairArray<java.lang.String,java.lang.String> p_list, int p_iSelectedIndex)
          Create an option list from a pair-array with the 0th option selected.
 java.lang.String getOptionListT(de.uplanet.util.PairArray<java.lang.String,java.lang.String> p_list, java.lang.String p_strSelectedText)
          Create an option list from a pair-array with specified option selected.
 java.lang.String getOptionListV(de.uplanet.util.PairArray<java.lang.String,java.lang.String> p_list, java.lang.String p_strSelectedValue)
          Create an option list from a pair-array with specified option selected.
 java.lang.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 java.lang.String getOutputType()
Get the currently selected output type.

Returns:
The output type.

getOptionList

public java.lang.String getOptionList(de.uplanet.util.PairArray<java.lang.String,java.lang.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 java.lang.String getOptionList(de.uplanet.util.PairArray<java.lang.String,java.lang.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 java.lang.String getOptionListV(de.uplanet.util.PairArray<java.lang.String,java.lang.String> p_list,
                                       java.lang.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 java.lang.String getOptionListT(de.uplanet.util.PairArray<java.lang.String,java.lang.String> p_list,
                                       java.lang.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.


Last updated: 2011-01-27
Copyright 2000-2010 United Planet. All Rights Reserved.