JFormDesigner 5.0.4 Runtime API

com.jformdesigner.model
Class FormModel

java.lang.Object
  extended by com.jformdesigner.model.FormObject
      extended by com.jformdesigner.model.FormModel

public class FormModel
extends FormObject

A form model represents a JFormDesigner form in memory.

FormLoader can be used to load a .jfd file and FormSaver to save a form model to a .jfd file. FormCreator can create Swing components from a form model.

Example:

   FormContainer panel = ... // see FormContainer

   FormRoot root = new FormRoot();
   root.add(panel);

   FormModel model = new FormModel();
   model.setContentType("form/swing");
   model.setRoot(root);
 


Field Summary
 java.lang.String fileHeader
          The header comment of the file or null.
 
Fields inherited from class com.jformdesigner.model.FormObject
NULL_VALUE
 
Constructor Summary
FormModel()
          Constructs a form model.
 
Method Summary
 boolean accept(FormBindingVisitor visitor)
          Accepts the given visitor.
 boolean accept(FormComponentVisitor visitor)
          Accepts the given visitor.
 java.lang.ClassLoader getClassLoader()
          Returns the class loader used to load the form model.
 java.lang.String getContentType()
          Returns the content type of the form model.
 com.jformdesigner.model.FormModelEventProvider getEventProvider()
          For internal use only.
 FormComponent getFormComponent(java.lang.String name)
          Returns the form component for the specified component name.
 java.lang.String[] getNames()
          Returns all form component names used in this form model.
 FormRoot getRoot()
          Returns the root of this form model.
 boolean isUndoRecording()
          For internal use only.
 void set_ClassLoader(java.lang.ClassLoader classLoader)
          For internal use only.
 void set_EventProvider(com.jformdesigner.model.FormModelEventProvider eventProvider)
          For internal use only.
 void setContentType(java.lang.String contentType)
          Sets the content type of the form model.
 void setRoot(FormRoot root)
          Sets the root of this form model.
 boolean setUndoRecording(boolean undoRecording)
          For internal use only.
 
Methods inherited from class com.jformdesigner.model.FormObject
getProperties, getProperty, getProperty, getPropertyBoolean, getPropertyBoolean, getPropertyCount, getPropertyDouble, getPropertyDouble, getPropertyInt, getPropertyInt, getPropertyNames, getPropertyString, getPropertyString, getReferenceCount, properties, propertyNames, setProperty, setProperty, setProperty, setPropertyBoolean, setPropertyBoolean, setPropertyDouble, setPropertyDouble, setPropertyInt, setPropertyInt, setPropertyString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

fileHeader

public java.lang.String fileHeader
The header comment of the file or null.

Since:
3.0
Constructor Detail

FormModel

public FormModel()
Constructs a form model.

Method Detail

getClassLoader

public java.lang.ClassLoader getClassLoader()
Returns the class loader used to load the form model.


set_ClassLoader

public void set_ClassLoader(java.lang.ClassLoader classLoader)
For internal use only.


getContentType

public java.lang.String getContentType()
Returns the content type of the form model.


setContentType

public void setContentType(java.lang.String contentType)
Sets the content type of the form model.

Use form/swing for Swing forms.


getRoot

public FormRoot getRoot()
Returns the root of this form model.


setRoot

public void setRoot(FormRoot root)
Sets the root of this form model. The root is a container for all top-level components in a form model.


getFormComponent

public FormComponent getFormComponent(java.lang.String name)
Returns the form component for the specified component name.


getNames

public java.lang.String[] getNames()
Returns all form component names used in this form model.


accept

public boolean accept(FormComponentVisitor visitor)
Accepts the given visitor. The visitor's FormComponentVisitor.visit(com.jformdesigner.model.FormComponent) is called with all form components of this form model.

Parameters:
visitor - The visitor.
Returns:
The result of FormComponentVisitor.visit(com.jformdesigner.model.FormComponent).
Since:
3.0

accept

public boolean accept(FormBindingVisitor visitor)
Accepts the given visitor. The visitor's FormBindingVisitor.visit(com.jformdesigner.model.FormBinding) is called with all form bindings of this form model.

Parameters:
visitor - The visitor.
Returns:
The result of FormBindingVisitor.visit(com.jformdesigner.model.FormBinding).
Since:
5.0

isUndoRecording

public boolean isUndoRecording()
For internal use only.


setUndoRecording

public boolean setUndoRecording(boolean undoRecording)
For internal use only.


getEventProvider

public com.jformdesigner.model.FormModelEventProvider getEventProvider()
For internal use only.

Since:
3.1

set_EventProvider

public void set_EventProvider(com.jformdesigner.model.FormModelEventProvider eventProvider)
For internal use only.

Since:
3.1

JFormDesigner 5.0.4 Runtime API

Copyright (C) 2004-2012 FormDev Software GmbH. All rights reserved.