JFormDesigner 5.0.4 Runtime API

com.jformdesigner.model
Class FormRoot

java.lang.Object
  extended by com.jformdesigner.model.FormObject
      extended by com.jformdesigner.model.FormComponent
          extended by com.jformdesigner.model.FormContainer
              extended by com.jformdesigner.model.FormRoot
All Implemented Interfaces:
FormSelectable

public class FormRoot
extends FormContainer

A form root is a container for all top-level components in a form model.


Field Summary
 
Fields inherited from class com.jformdesigner.model.FormContainer
FIELD_MENU_BAR
 
Fields inherited from class com.jformdesigner.model.FormComponent
FIELD_NAME
 
Fields inherited from class com.jformdesigner.model.FormObject
NULL_VALUE
 
Constructor Summary
FormRoot()
          Constructs a form root.
 
Method Summary
 boolean accept(FormBindingVisitor visitor)
          Accepts the given visitor.
 void addBindingGroup(FormBindingGroup bindingGroup)
          Adds a form binding group to the end of this form root.
 void addBindingGroup(FormBindingGroup bindingGroup, int index)
          Adds a form binding group to this form root at the specified position.
 java.lang.Object clone()
          Clones this form root.
 FormBindingGroup getBindingGroup(int index)
          Returns the form binding group at index.
 FormBindingGroup getBindingGroup(java.lang.String name)
          Returns the form binding group for the given name.
 int getBindingGroupCount()
          Returns the number of form binding groups in this form root.
 int getBindingGroupIndex(FormBindingGroup bindingGroup)
          Returns the index of bindingGroup in this form; or -1 if the binding group is not a child of this form.
 FormBindingGroup[] getBindingGroups()
          Returns all form binding groups in this form root.
 void removeBindingGroup(FormBindingGroup bindingGroup)
          Removes the specified form binding group from this form root.
 void removeBindingGroup(int index)
          Removes the form binding group at the specified index from this form root.
 
Methods inherited from class com.jformdesigner.model.FormContainer
accept, add, add, add, add, getComponent, getComponentCount, getComponentIndex, getComponents, getLayout, getMenuBar, getMenuBarAndComponents, getMenuBarOwner, remove, remove, remove, removeAll, setLayout, setMenuBar
 
Methods inherited from class com.jformdesigner.model.FormComponent
addEvent, addEvent, auxiliary, getAuxiliaryPropertyBoolean, getAuxiliaryPropertyInt, getAuxiliaryPropertyString, getClassName, getConstraints, getEvent, getEventCount, getEvents, getModel, getName, getParent, hasAuxiliary, removeEvent, removeEvent, setName, toString
 
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
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FormRoot

public FormRoot()
Constructs a form root.

Method Detail

clone

public java.lang.Object clone()
Clones this form root.

Overrides:
clone in class FormContainer

getBindingGroupCount

public int getBindingGroupCount()
Returns the number of form binding groups in this form root.

Since:
5.0

getBindingGroup

public FormBindingGroup getBindingGroup(int index)
Returns the form binding group at index.

Since:
5.0

getBindingGroup

public FormBindingGroup getBindingGroup(java.lang.String name)
Returns the form binding group for the given name.

Since:
5.0

getBindingGroups

public FormBindingGroup[] getBindingGroups()
Returns all form binding groups in this form root.

Since:
5.0

getBindingGroupIndex

public int getBindingGroupIndex(FormBindingGroup bindingGroup)
Returns the index of bindingGroup in this form; or -1 if the binding group is not a child of this form.


addBindingGroup

public void addBindingGroup(FormBindingGroup bindingGroup)
Adds a form binding group to the end of this form root.

Since:
5.0

addBindingGroup

public void addBindingGroup(FormBindingGroup bindingGroup,
                            int index)
Adds a form binding group to this form root at the specified position.

Parameters:
bindingGroup - The form binding group to be added.
index - The position in the binding group list at which to insert the binding group; or -1 to insert at the end
Since:
5.0

removeBindingGroup

public void removeBindingGroup(FormBindingGroup bindingGroup)
Removes the specified form binding group from this form root.

Since:
5.0

removeBindingGroup

public void removeBindingGroup(int index)
Removes the form binding group at the specified index from this form root.

Since:
5.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 root.

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

JFormDesigner 5.0.4 Runtime API

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