public abstract class ParameterSection
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
protected java.util.Map<java.lang.String,?> |
data |
protected java.lang.String |
dynamicKey |
protected ParameterValueLoader |
parameterValueLoader
ParameterValueLoader that can be used to
|
Constructor and Description |
---|
ParameterSection() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.Object |
convertParameterToJSON(java.lang.String original)
Helper method to converts JSON to it's equivilent java object (for lists, maps and booleans) so that the javascript
interepting it isn't just sent a string like "[1,2,3]"
|
abstract java.util.Map<java.lang.String,?> |
getData()
Data object for the level, should contain data relevant for the Parameters
|
abstract java.util.List<ParameterDisplayRule> |
getDisplayRules()
Displays to determine whether or not the Section should be visible
|
java.lang.String |
getDynamicKey() |
abstract java.lang.String |
getName()
Display name of the object
|
abstract java.util.List<Parameter> |
getParameters()
List of the options that will be displayed on the interface
|
java.util.List<Parameter> |
getParameters(java.lang.String type)
Return all params of a specific type in this Section.
|
java.lang.String |
getParameterSectionClassName()
Return a styleclass for a Parameter Section
|
abstract java.lang.String |
getSectionKey()
Returns the key for the model, should be unique within a ParameterPanel
Is used to access the data object on the interface
|
abstract GeneralPanelOptions |
getSectionOptions()
General options that are used by multiple levels in the Parameter hierarchy
|
boolean |
isDynamic() |
void |
setDynamicKey(java.lang.String dynamicKey) |
void |
setPanelLocation(java.lang.String panelKey)
Method to set the parents location, is called automatically during toJSON so that the section should have a parent parameter
|
void |
setParameterValueLoader(ParameterValueLoader pvl) |
void |
setSortOrder(int sortOrder)
Update the sort order so that we can ensure that the interface will be in the correct order
Not Used for JS interface
|
org.json.JSONObject |
toJSON() |
protected java.lang.String dynamicKey
protected java.util.Map<java.lang.String,?> data
protected ParameterValueLoader parameterValueLoader
public java.lang.String getDynamicKey()
public void setDynamicKey(java.lang.String dynamicKey)
public abstract java.lang.String getSectionKey()
public abstract java.lang.String getName()
public java.lang.String getParameterSectionClassName()
public abstract java.util.List<Parameter> getParameters()
public abstract java.util.List<ParameterDisplayRule> getDisplayRules()
public abstract GeneralPanelOptions getSectionOptions()
public abstract java.util.Map<java.lang.String,?> getData()
public void setPanelLocation(java.lang.String panelKey)
panelKey
- public void setSortOrder(int sortOrder)
sortOrder
- public void setParameterValueLoader(ParameterValueLoader pvl)
public boolean isDynamic()
public org.json.JSONObject toJSON()
protected java.lang.Object convertParameterToJSON(java.lang.String original)
original
- public java.util.List<Parameter> getParameters(java.lang.String type)
type
- - Type of parameter to search for.
If this is null, the method returns all params.
Otherwise this should be a Special Input Type or the string representation of an InputType