|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.partnersoft.gui.GUIBuilder
com.partnersoft.gui.forms.FormBuilder
public class FormBuilder
A schema- and Forms-aware GUI building tool.
FormBuilder inherits from GUIBuilder and has all of its layout and component-adding tools. It also manages a Form, and adds FormFields to the form while also adding them to the layout. Convenience methods abound, but of particular note are the schema-aware methods of the form add*BySchema() and buildStandard*BySchema() methods. These make it easy to generate basic data-entry forms for predefined CogSchemas.
Copyright 2008-2009 Partner Software, Inc.
| Constructor Summary | |
|---|---|
FormBuilder()
|
|
FormBuilder(java.awt.Container starterPanel)
|
|
| Method Summary | |
|---|---|
FormButton |
addButton(java.lang.String label,
java.lang.String actionMethod)
This adds a button with the specified label, that calls the named method on the action handler. |
FormButton |
addButton(java.lang.String label,
java.lang.String actionMethod,
java.lang.Object layoutInfo)
This adds a button with the specified label, that calls the named method on the action handler. |
FormCheckboxField |
addCheckboxField(java.lang.String name)
Adds a checkbox field with the given name, with no layout info. |
FormCheckboxField |
addCheckboxField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a checkbox field with the given name, with the specified layout info. |
FormColorField |
addColorField(java.lang.String name)
|
FormColorField |
addColorField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
|
FormComboField |
addComboField(java.lang.String name,
java.util.Collection items)
Adds a combo box field with the given name and collection of possibilities, with no layout info. |
FormComboField |
addComboField(java.lang.String name,
java.util.Collection items,
java.lang.Object fieldLayoutInfo)
Adds a combo box field with the given name and collection of possibilities, with the specified layout info. |
FormComboField |
addComboFieldWithValues(java.lang.String name,
java.lang.String... values)
|
void |
addComponent(java.awt.Component component,
java.lang.Object layoutInfo)
|
FormDateAndTimeField |
addDateAndTimeField(java.lang.String name)
Adds a date field with the given name, with no layout info. |
FormDateAndTimeField |
addDateAndTimeField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a date field with the given name, with the specified layout info. |
FormDateField |
addDateField(java.lang.String name)
Adds a date field with the given name, with no layout info. |
FormDateField |
addDateField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a date field with the given name, with the specified layout info. |
FormDurationField |
addDurationField(java.lang.String name)
|
FormDurationField |
addDurationField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
|
FormField |
addField(java.lang.String name,
FormField field)
Adds the given FormField component, associated
with the given field name, with no layout info. |
FormField |
addField(java.lang.String name,
FormField field,
java.lang.Object layoutInfo)
Adds the given FormField component, associated
with the given field name and layout info. |
FormField |
addField(java.lang.String name,
java.lang.String fieldType)
Acts like addFOOField for the given fieldType "FOO". |
FormField |
addField(java.lang.String name,
java.lang.String fieldType,
int size,
java.lang.Object layoutInfo)
Acts like addFOOField for the given fieldType "FOO". |
FormField |
addField(java.lang.String name,
java.lang.String fieldType,
java.lang.Object layoutInfo)
Acts like addFOOField for the given fieldType "FOO". |
FormField |
addFieldBySchema(CogStructureField field)
Adds the given field, with the correct type and description based on the schema. |
FormField |
addFieldBySchema(CogStructureField field,
java.lang.Object layoutInfo)
Adds the given field, with the correct type and description, using the given layout info. |
FormField |
addFieldBySchema(java.lang.String fieldName)
Adds the given field, with the correct type and description based on the schema. |
FormField |
addFieldBySchema(java.lang.String fieldName,
java.lang.Object layoutInfo)
Adds the given field, with the correct type and description, using the given layout info. |
FormFilePathField |
addFilePathField(java.lang.String name)
Adds a filename field with the given name, with no layout info. |
FormFilePathField |
addFilePathField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a filename field with the given name, with the specified layout info. |
FormFilePathListField |
addFilePathListField(java.lang.String name)
|
FormFilePathListField |
addFilePathListField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
|
FormIntegerField |
addIntegerField(java.lang.String name)
Adds a Integer field with the given name, with no layout info. |
FormIntegerField |
addIntegerField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a Integer field with the given name, with the specified layout info. |
void |
addLabelAndFieldBySchema(CogStructureField field)
Adds the given field along with its label (label first). |
void |
addLabelAndFieldBySchema(java.lang.String fieldName)
Adds the given field along with its label (label first). |
javax.swing.JLabel |
addLabelBySchema(CogStructureField field)
Adds the given field's label as listed in the schema. |
javax.swing.JLabel |
addLabelBySchema(CogStructureField field,
java.lang.Object layoutInfo)
Adds the given field's label as listed in the schema, using the given layout info. |
javax.swing.JLabel |
addLabelBySchema(java.lang.String fieldName)
Adds the given field's label as listed in the schema. |
javax.swing.JLabel |
addLabelBySchema(java.lang.String fieldName,
java.lang.Object layoutInfo)
Adds the given field's label as listed in the schema, using the given layout info. |
FormNamedBlobField |
addNamedBlobField(java.lang.String name)
|
FormNamedBlobField |
addNamedBlobField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
|
FormNumberField |
addNumberField(java.lang.String name)
Adds a Number field with the given name, with no layout info. |
FormNumberField |
addNumberField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a Number field with the given name, with the specified layout info. |
FormPasswordField |
addPasswordField(java.lang.String name)
Adds a password field with the given name, with no layout info. |
FormPasswordField |
addPasswordField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a password field with the given name, with the specified layout info. |
FormPicklistField |
addPicklistField(java.lang.String name,
java.util.Collection items)
Adds a picklist field with the given name and collection of possibilities, with no layout info. |
FormPicklistField |
addPicklistField(java.lang.String name,
java.util.Collection items,
java.lang.Object fieldLayoutInfo)
Adds a picklist field with the given name and collection of possibilities, with the specified layout info. |
FormPicklistField |
addPicklistFieldWithValues(java.lang.String name,
java.lang.String... values)
|
FormRandomIntegerField |
addRandomIntegerField(java.lang.String name,
int size)
Adds a randomizeable Integer field with the given name, with no layout info. |
FormRandomIntegerField |
addRandomIntegerField(java.lang.String name,
int size,
java.lang.Object fieldLayoutInfo)
Adds a randomizable Integer field with the given name, with the specified layout info. |
FormReadOnlyStringField |
addReadOnlyStringField(java.lang.String name)
Adds a read-only string field with the given name, with no layout info. |
FormReadOnlyStringField |
addReadOnlyStringField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a string field with the given name, with the specified layout info. |
FormStringField |
addStringField(java.lang.String name)
Adds a string field with the given name, with no layout info. |
FormStringField |
addStringField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a string field with the given name, with the specified layout info. |
FormField |
addSubformFieldBySchema(java.lang.String path,
CogStructureField field)
Adds the given field, with the correct type and description based on the schema. |
FormField |
addSubformFieldBySchema(java.lang.String path,
CogStructureField field,
java.lang.Object layoutInfo)
Adds the given field, with the correct type and description, using the given layout info. |
void |
addSubformLabelAndFieldBySchema(java.lang.String path,
CogStructureField field)
Adds the given field along with its label (label first). |
FormTextField |
addTextField(java.lang.String name)
Adds a string field with the given name, with no layout info. |
FormTextField |
addTextField(java.lang.String name,
int columns,
int rows)
Adds a string field with the given name, with no layout info. |
FormTextField |
addTextField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a string field with the given name, with the specified layout info. |
FormTextField |
addTextField(java.lang.String name,
java.lang.Object fieldLayoutInfo,
int columns,
int rows)
Adds a string field with the given name, with the specified layout info. |
FormTimeField |
addTimeField(java.lang.String name)
Adds a date field with the given name, with no layout info. |
FormTimeField |
addTimeField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
Adds a date field with the given name, with the specified layout info. |
void |
buildStandardTabbedLayout(boolean scrollable,
java.lang.String... tabs)
This does a standard layout with just the named tabs, based on the fields.csv tab entries. |
void |
buildStandardTabbedLayout(java.lang.String... tabs)
This does a standard layout with just the named tabs, based on the fields.csv tab entries. |
void |
buildStandardTabbedLayoutBySchema()
This does a standard layout with tabs, based on the fields.csv tab entries. |
void |
buildStandardTabbedLayoutBySchema(boolean scrollable)
This does a standard layout with tabs, based on the fields.csv tab entries. |
void |
buildStandardTabbedLayoutBySchema(boolean scrollable,
java.util.List<java.lang.String> tabs)
This does a standard layout with just the named tabs, based on the fields.csv tab entries. |
void |
buildStandardTabbedLayoutBySchema(java.util.List<java.lang.String> tabs)
This does a standard layout with just the named tabs, based on the fields.csv tab entries. |
void |
buildSubformBySchema(java.lang.String fieldName)
This does a standard layout with tabs, based on the fields.csv tab entries. |
void |
buildSubformBySchema(java.lang.String fieldName,
java.util.List<java.lang.String> tabs)
This does a standard layout with just the named tabs, based on the fields.csv tab entries. |
void |
defineCustomField(java.lang.String name,
FormField field)
Adds the given field as a custom implementation. |
Form |
finishForm()
|
static FormBuilder |
forScrollPane()
Convenience factory method to generate a form builder for a scroll pane. |
static FormBuilder |
forTabbedPane()
Convenience factory method to generate a form builder for a tabbed pane. |
CogStructureType |
getEditedType()
|
java.lang.String |
getEditedTypeName()
|
Form |
getForm()
Returns the Form object. |
CogSchema |
getSchema()
Gets the current CogSchema used by this FormBuilder. |
FormField |
removeField(java.lang.String name,
FormField field)
|
void |
replaceField(java.lang.String name,
FormField newField)
|
void |
setActionMethodProvider(java.lang.Object newProvider)
Sets the action method provider for the form. |
void |
setEditedType(CogStructureType newType)
|
void |
setEditedTypeName(java.lang.String string)
|
void |
setSchema(CogSchema newSchema)
Set the CogSchema used by this FormBuilder. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public FormBuilder(java.awt.Container starterPanel)
public FormBuilder()
| Method Detail |
|---|
public static FormBuilder forTabbedPane()
public static FormBuilder forScrollPane()
public void setActionMethodProvider(java.lang.Object newProvider)
public void defineCustomField(java.lang.String name,
FormField field)
public FormField addFieldBySchema(java.lang.String fieldName)
public FormField addFieldBySchema(java.lang.String fieldName,
java.lang.Object layoutInfo)
public FormField addFieldBySchema(CogStructureField field)
public FormField addFieldBySchema(CogStructureField field,
java.lang.Object layoutInfo)
public FormField addSubformFieldBySchema(java.lang.String path,
CogStructureField field)
public FormField addSubformFieldBySchema(java.lang.String path,
CogStructureField field,
java.lang.Object layoutInfo)
public javax.swing.JLabel addLabelBySchema(java.lang.String fieldName)
public javax.swing.JLabel addLabelBySchema(java.lang.String fieldName,
java.lang.Object layoutInfo)
public javax.swing.JLabel addLabelBySchema(CogStructureField field)
public javax.swing.JLabel addLabelBySchema(CogStructureField field,
java.lang.Object layoutInfo)
public void addLabelAndFieldBySchema(java.lang.String fieldName)
public void addLabelAndFieldBySchema(CogStructureField field)
public void addSubformLabelAndFieldBySchema(java.lang.String path,
CogStructureField field)
public void buildStandardTabbedLayoutBySchema()
public void buildStandardTabbedLayout(java.lang.String... tabs)
public void buildStandardTabbedLayoutBySchema(java.util.List<java.lang.String> tabs)
public void buildStandardTabbedLayoutBySchema(boolean scrollable)
public void buildStandardTabbedLayout(boolean scrollable,
java.lang.String... tabs)
public void buildStandardTabbedLayoutBySchema(boolean scrollable,
java.util.List<java.lang.String> tabs)
public void buildSubformBySchema(java.lang.String fieldName)
public void buildSubformBySchema(java.lang.String fieldName,
java.util.List<java.lang.String> tabs)
public Form finishForm()
public FormButton addButton(java.lang.String label,
java.lang.String actionMethod)
public FormButton addButton(java.lang.String label,
java.lang.String actionMethod,
java.lang.Object layoutInfo)
public FormPasswordField addPasswordField(java.lang.String name)
public FormPasswordField addPasswordField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormTextField addTextField(java.lang.String name,
int columns,
int rows)
public FormTextField addTextField(java.lang.String name)
public FormStringField addStringField(java.lang.String name)
public FormStringField addStringField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormReadOnlyStringField addReadOnlyStringField(java.lang.String name)
public FormReadOnlyStringField addReadOnlyStringField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormNumberField addNumberField(java.lang.String name)
public FormNumberField addNumberField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormIntegerField addIntegerField(java.lang.String name)
public FormIntegerField addIntegerField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormRandomIntegerField addRandomIntegerField(java.lang.String name,
int size)
public FormRandomIntegerField addRandomIntegerField(java.lang.String name,
int size,
java.lang.Object fieldLayoutInfo)
public FormTextField addTextField(java.lang.String name,
java.lang.Object fieldLayoutInfo,
int columns,
int rows)
public FormTextField addTextField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormPicklistField addPicklistField(java.lang.String name,
java.util.Collection items)
public FormPicklistField addPicklistField(java.lang.String name,
java.util.Collection items,
java.lang.Object fieldLayoutInfo)
public FormPicklistField addPicklistFieldWithValues(java.lang.String name,
java.lang.String... values)
public FormComboField addComboField(java.lang.String name,
java.util.Collection items)
public FormComboField addComboField(java.lang.String name,
java.util.Collection items,
java.lang.Object fieldLayoutInfo)
public FormComboField addComboFieldWithValues(java.lang.String name,
java.lang.String... values)
public FormCheckboxField addCheckboxField(java.lang.String name)
public FormCheckboxField addCheckboxField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormDateAndTimeField addDateAndTimeField(java.lang.String name)
public FormDateAndTimeField addDateAndTimeField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormTimeField addTimeField(java.lang.String name)
public FormTimeField addTimeField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormDateField addDateField(java.lang.String name)
public FormDateField addDateField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormFilePathField addFilePathField(java.lang.String name)
public FormFilePathField addFilePathField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormFilePathListField addFilePathListField(java.lang.String name)
public FormFilePathListField addFilePathListField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormNamedBlobField addNamedBlobField(java.lang.String name)
public FormNamedBlobField addNamedBlobField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormColorField addColorField(java.lang.String name)
public FormColorField addColorField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormDurationField addDurationField(java.lang.String name,
java.lang.Object fieldLayoutInfo)
public FormDurationField addDurationField(java.lang.String name)
public FormField addField(java.lang.String name,
FormField field)
FormField component, associated
with the given field name, with no layout info. Does not add a label.
public FormField addField(java.lang.String name,
FormField field,
java.lang.Object layoutInfo)
FormField component, associated
with the given field name and layout info. Does not add a label.
public FormField addField(java.lang.String name,
java.lang.String fieldType)
public FormField addField(java.lang.String name,
java.lang.String fieldType,
java.lang.Object layoutInfo)
public FormField addField(java.lang.String name,
java.lang.String fieldType,
int size,
java.lang.Object layoutInfo)
public FormField removeField(java.lang.String name,
FormField field)
public void setSchema(CogSchema newSchema)
public CogSchema getSchema()
public void setEditedType(CogStructureType newType)
public void setEditedTypeName(java.lang.String string)
public CogStructureType getEditedType()
public java.lang.String getEditedTypeName()
public Form getForm()
public void replaceField(java.lang.String name,
FormField newField)
public void addComponent(java.awt.Component component,
java.lang.Object layoutInfo)
addComponent in class GUIBuilder
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||