public class FormMeta extends java.lang.Object implements java.io.Serializable, java.lang.Comparable<FormMeta>
Modifier and Type | Class and Description |
---|---|
static interface |
FormMeta.IExtendedDescriptionSource |
Modifier and Type | Field and Description |
---|---|
protected Category |
category
The category that the field belongs to.
|
protected boolean |
enabled
Controls whether or not the field, if visible, is enabled on an add/edit screen
|
protected boolean |
escapeHTMLOnDisplay
Whether or not the value of this field should be escaped when displayed.
|
protected SFieldMeta |
field |
protected java.lang.String |
fieldDescriptionKey |
protected java.lang.String |
fieldDescriptionKeyAddMode |
protected java.lang.String |
fieldDescriptionKeyEditMode |
protected java.lang.String |
fieldNameKey |
protected int |
fieldOrder
The relative order (within this field's category) that the field should appear.
|
protected boolean |
required
alternate required method.
|
protected boolean |
showDefault
Whether or not the field's default value should be shown on an add/edit screen
|
protected java.util.List<org.apache.wicket.validation.IValidator> |
validators
A list of wicket validators that should be applied to the field
|
protected boolean |
visible
Controls whether or not the field is visible on an add/edit screen
|
Constructor and Description |
---|
FormMeta(SFieldMeta field) |
FormMeta(SFieldMeta field,
IEditorSource editorSource) |
Modifier and Type | Method and Description |
---|---|
FormMeta |
addValidator(org.apache.wicket.validation.IValidator validator) |
int |
compareTo(FormMeta o) |
Category |
getCategory() |
IEditorSource |
getEditorSource() |
org.apache.wicket.model.IModel |
getExtendedDescription(SRecordInstance record)
Provided for subclasses to have custom logic to look up any record-specific instructions for a field
|
FormMeta.IExtendedDescriptionSource |
getExtendedDescriptionSource() |
SFieldMeta |
getField() |
java.lang.String |
getFieldDescriptionKey() |
java.lang.String |
getFieldDescriptionKeyAddMode() |
java.lang.String |
getFieldDescriptionKeyEditMode() |
java.lang.String |
getFieldNameKey() |
int |
getFieldOrder() |
java.util.List<org.apache.wicket.validation.IValidator> |
getValidators() |
org.apache.wicket.markup.html.form.FormComponent |
installValidators(org.apache.wicket.markup.html.form.FormComponent c) |
boolean |
isEnabled() |
boolean |
isEscapeHTMLOnDisplay() |
boolean |
isRequired() |
boolean |
isShowDefault() |
boolean |
isVisible() |
org.apache.wicket.Component |
newEditorComponent(java.lang.String id,
RecordEditMode mode,
SRecordInstance record) |
FormMeta |
setCategory(Category category) |
FormMeta |
setCategory(java.lang.String displayKey,
int order) |
FormMeta |
setEditorSource(IEditorSource editorSource) |
FormMeta |
setEnabled(boolean enabled) |
FormMeta |
setEscapeHTMLOnDisplay(boolean escapeHTMLOnDisplay) |
FormMeta |
setExtendedDescriptionSource(FormMeta.IExtendedDescriptionSource extendedDescriptionSource) |
FormMeta |
setFieldDescriptionKey(java.lang.String fieldDescriptionKey) |
FormMeta |
setFieldDescriptionKeyAddMode(java.lang.String fieldDescriptionKeyAddMode) |
FormMeta |
setFieldDescriptionKeyEditMode(java.lang.String fieldDescriptionKeyEditMode) |
FormMeta |
setFieldNameKey(java.lang.String fieldNameKey) |
FormMeta |
setFieldOrder(int fieldOrder) |
FormMeta |
setRequired(boolean required)
Normally, a field is marked as required by using the SMANDATORY field flag.
|
FormMeta |
setShowDefault(boolean showDefault) |
FormMeta |
setVisible(boolean visible) |
java.lang.String |
toString() |
protected SFieldMeta field
protected java.lang.String fieldNameKey
protected java.lang.String fieldDescriptionKey
protected java.lang.String fieldDescriptionKeyAddMode
protected java.lang.String fieldDescriptionKeyEditMode
protected boolean showDefault
protected boolean visible
protected boolean enabled
protected boolean required
protected boolean escapeHTMLOnDisplay
protected int fieldOrder
protected java.util.List<org.apache.wicket.validation.IValidator> validators
protected Category category
public FormMeta(SFieldMeta field)
public FormMeta(SFieldMeta field, IEditorSource editorSource)
public java.lang.String toString()
toString
in class java.lang.Object
public SFieldMeta getField()
public FormMeta addValidator(org.apache.wicket.validation.IValidator validator)
public java.util.List<org.apache.wicket.validation.IValidator> getValidators()
public boolean isVisible()
public FormMeta setVisible(boolean visible)
public boolean isRequired()
public FormMeta setRequired(boolean required)
public Category getCategory()
public FormMeta setCategory(java.lang.String displayKey, int order)
public int getFieldOrder()
public FormMeta setFieldOrder(int fieldOrder)
public java.lang.String getFieldNameKey()
public FormMeta setFieldNameKey(java.lang.String fieldNameKey)
public java.lang.String getFieldDescriptionKey()
public FormMeta setFieldDescriptionKey(java.lang.String fieldDescriptionKey)
public org.apache.wicket.model.IModel getExtendedDescription(SRecordInstance record)
public org.apache.wicket.Component newEditorComponent(java.lang.String id, RecordEditMode mode, SRecordInstance record)
public IEditorSource getEditorSource()
public FormMeta setEditorSource(IEditorSource editorSource)
public boolean isShowDefault()
public FormMeta setShowDefault(boolean showDefault)
public org.apache.wicket.markup.html.form.FormComponent installValidators(org.apache.wicket.markup.html.form.FormComponent c)
public int compareTo(FormMeta o)
compareTo
in interface java.lang.Comparable<FormMeta>
public java.lang.String getFieldDescriptionKeyAddMode()
public FormMeta setFieldDescriptionKeyAddMode(java.lang.String fieldDescriptionKeyAddMode)
public java.lang.String getFieldDescriptionKeyEditMode()
public FormMeta setFieldDescriptionKeyEditMode(java.lang.String fieldDescriptionKeyEditMode)
public FormMeta.IExtendedDescriptionSource getExtendedDescriptionSource()
public FormMeta setExtendedDescriptionSource(FormMeta.IExtendedDescriptionSource extendedDescriptionSource)
public boolean isEnabled()
public FormMeta setEnabled(boolean enabled)
public boolean isEscapeHTMLOnDisplay()
public FormMeta setEscapeHTMLOnDisplay(boolean escapeHTMLOnDisplay)