moapi
Class ModTextOption

java.lang.Object
  extended by moapi.ModOption<java.lang.String>
      extended by moapi.ModTextOption

public class ModTextOption
extends ModOption<java.lang.String>

A text input field option for modoptionsapi with customisable maximum length

Since:
0.7

Field Summary
 
Fields inherited from class moapi.ModOption
callback, global, localValue, name, value
 
Constructor Summary
ModTextOption(java.lang.String name)
          Constructor for the text option
ModTextOption(java.lang.String name, int maxLen)
          Constructor for the text option specifying max length
ModTextOption(java.lang.String name, java.lang.Integer maxLen)
          Constructor for the text option specifying max length
ModTextOption(java.lang.String id, java.lang.String name)
          Constructor with a given name and ID
ModTextOption(java.lang.String id, java.lang.String name, int maxLen)
          Constructor for text option with given name and ID and a given max length
ModTextOption(java.lang.String id, java.lang.String name, java.lang.Integer maxLen)
          Constructor for the text option specifying max length, name and ID
 
Method Summary
 int getMaxLength()
          Get the maximum value for the input length
 void setMaxLength(int maxlen)
          Set maximum length for the input
 void setMaxLength(java.lang.Integer maxlen)
          Set maximum length for the input
 
Methods inherited from class moapi.ModOption
getCallback, getGlobalValue, getID, getLocalValue, getName, getValue, getValue, hasCallback, setCallback, setGlobal, setGlobalValue, setLocalValue, setName, setValue, setValue, useGlobalValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ModTextOption

public ModTextOption(java.lang.String name)
Constructor for the text option

Parameters:
name - Name of option
Since:
0.7

ModTextOption

public ModTextOption(java.lang.String id,
                     java.lang.String name)
Constructor with a given name and ID

Parameters:
id - ID of option
name - Name of option
Since:
0.8

ModTextOption

public ModTextOption(java.lang.String name,
                     java.lang.Integer maxLen)
Constructor for the text option specifying max length

Parameters:
name - Name of option
maxLen - Maximum length of text entered
Since:
0.7

ModTextOption

public ModTextOption(java.lang.String id,
                     java.lang.String name,
                     java.lang.Integer maxLen)
Constructor for the text option specifying max length, name and ID

Parameters:
id - ID of option
name - Name of option
maxLen - Maximum length of text entered
Since:
0.8

ModTextOption

public ModTextOption(java.lang.String name,
                     int maxLen)
Constructor for the text option specifying max length

Parameters:
name - Name of option
maxLen - Maximum length of text entered
Since:
0.7

ModTextOption

public ModTextOption(java.lang.String id,
                     java.lang.String name,
                     int maxLen)
Constructor for text option with given name and ID and a given max length

Parameters:
id - ID of this option
name - Name of this option
Since:
0.8
Method Detail

setMaxLength

public void setMaxLength(int maxlen)
Set maximum length for the input

Parameters:
maxlen - Maximum length inputtable. 0 or less is infinite
Since:
0.7

setMaxLength

public void setMaxLength(java.lang.Integer maxlen)
Set maximum length for the input

Parameters:
maxlen - Maximum length inputtable
Since:
0.7

getMaxLength

public int getMaxLength()
Get the maximum value for the input length

Returns:
Maximum length value
Since:
0.7