org.makumba.forms.html
Class ptrEditor

java.lang.Object
  extended by org.makumba.commons.formatters.FieldFormatter
      extended by org.makumba.forms.html.FieldEditor
          extended by org.makumba.forms.html.choiceEditor
              extended by org.makumba.forms.html.ptrEditor
Direct Known Subclasses:
setEditor

public class ptrEditor
extends choiceEditor


Field Summary
 
Fields inherited from class org.makumba.forms.html.choiceEditor
_params, _paramValues, nullOption
 
Fields inherited from class org.makumba.forms.html.FieldEditor
ERROR_NO_BOOLEAN, ERROR_NO_INT, ERROR_NO_REAL, extraFormattingParam, formName, params, paramValues, suffixName
 
Constructor Summary
protected ptrEditor()
          Don't use this, use getInstance()
 
Method Summary
 String format(RecordFormatter rf, int fieldIndex, Object o, Dictionary<String,Object> formatParams)
          Format the object to pure text.
 String formatOptionTitle(RecordFormatter rf, int fieldIndex, Object options, int i)
          Gets the title/label of option 'i'.
 String formatOptionValue(RecordFormatter rf, int fieldIndex, Object val)
          Formats an option value.
 String formatOptionValue(RecordFormatter rf, int fieldIndex, Object opts, int i, Object val)
          Formats an option value, in the sequence of options.
 String formatValue(RecordFormatter rf, int fieldIndex, Object o, Dictionary<String,Object> formatParams)
          Formats the value to appear in an input statement.
 int getDefaultSize(RecordFormatter rf, int fieldIndex)
          Gets the default size of the select HTML box.
static FieldFormatter getInstance()
           
 Object getOptions(RecordFormatter rf, int fieldIndex, Dictionary<String,Object> formatParams)
          Get the available options.
 int getOptionsLength(RecordFormatter rf, int fieldIndex, Object opts)
          Gets the number of available options.
 Object getOptionValue(RecordFormatter rf, int fieldIndex, Object options, int i)
          Gets the value of option 'i'.
 boolean isMultiple(RecordFormatter rf, int fieldIndex)
          Returns blank string, or " multiple " if multiple selections possible.
 void onStartup(RecordFormatter rf, int fieldIndex)
           
 Object readFrom(RecordFormatter rf, int fieldIndex, HttpParameters p, String suffix)
          Reads, converts and validates the value present in the HttpParameters, for the FieldEditor indicated by the given index.
 
Methods inherited from class org.makumba.forms.html.choiceEditor
getAcceptedParams, getAcceptedValue, getValueOrDefault, setNullOption, shouldRemoveNullValue
 
Methods inherited from class org.makumba.forms.html.FieldEditor
checkParam, formatHidden, formatHiddenValue, formatShow, getExtraFormatting, getInputID, getInputName, getInputName, getSuffix, readFrom, setExtraFormatting, setFormName, setSuffix, toInt, toReal
 
Methods inherited from class org.makumba.commons.formatters.FieldFormatter
checkParams, equals, formatNotNull, formatNull, getDefaultValueFormat, getEmptyValueFormat, getExpr, getIntParam, getIntParamString, initExpr, resetValueFormat
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ptrEditor

protected ptrEditor()
Don't use this, use getInstance()

Method Detail

getInstance

public static FieldFormatter getInstance()

onStartup

public void onStartup(RecordFormatter rf,
                      int fieldIndex)
Overrides:
onStartup in class FieldEditor

getOptions

public Object getOptions(RecordFormatter rf,
                         int fieldIndex,
                         Dictionary<String,Object> formatParams)
Description copied from class: choiceEditor
Get the available options.

Specified by:
getOptions in class choiceEditor

getOptionsLength

public int getOptionsLength(RecordFormatter rf,
                            int fieldIndex,
                            Object opts)
Description copied from class: choiceEditor
Gets the number of available options.

Specified by:
getOptionsLength in class choiceEditor

getOptionValue

public Object getOptionValue(RecordFormatter rf,
                             int fieldIndex,
                             Object options,
                             int i)
Description copied from class: choiceEditor
Gets the value of option 'i'.

Specified by:
getOptionValue in class choiceEditor

formatOptionValue

public String formatOptionValue(RecordFormatter rf,
                                int fieldIndex,
                                Object val)
Description copied from class: choiceEditor
Formats an option value.

Specified by:
formatOptionValue in class choiceEditor

formatOptionValue

public String formatOptionValue(RecordFormatter rf,
                                int fieldIndex,
                                Object opts,
                                int i,
                                Object val)
Description copied from class: choiceEditor
Formats an option value, in the sequence of options.

Specified by:
formatOptionValue in class choiceEditor

formatOptionTitle

public String formatOptionTitle(RecordFormatter rf,
                                int fieldIndex,
                                Object options,
                                int i)
Description copied from class: choiceEditor
Gets the title/label of option 'i'.

Specified by:
formatOptionTitle in class choiceEditor

readFrom

public Object readFrom(RecordFormatter rf,
                       int fieldIndex,
                       HttpParameters p,
                       String suffix)
Description copied from class: FieldEditor
Reads, converts and validates the value present in the HttpParameters, for the FieldEditor indicated by the given index.

Overrides:
readFrom in class FieldEditor

isMultiple

public boolean isMultiple(RecordFormatter rf,
                          int fieldIndex)
Description copied from class: choiceEditor
Returns blank string, or " multiple " if multiple selections possible.

Specified by:
isMultiple in class choiceEditor

getDefaultSize

public int getDefaultSize(RecordFormatter rf,
                          int fieldIndex)
Description copied from class: choiceEditor
Gets the default size of the select HTML box.

Specified by:
getDefaultSize in class choiceEditor

format

public String format(RecordFormatter rf,
                     int fieldIndex,
                     Object o,
                     Dictionary<String,Object> formatParams)
Description copied from class: FieldFormatter
Format the object to pure text. If text-format is blank, try the "empty" replacer value.

Overrides:
format in class choiceEditor
Parameters:
rf - TODO
fieldIndex - TODO

formatValue

public String formatValue(RecordFormatter rf,
                          int fieldIndex,
                          Object o,
                          Dictionary<String,Object> formatParams)
Formats the value to appear in an input statement.

Overrides:
formatValue in class FieldEditor