com.codename1.rad.nodes

Class FormNode

java.lang.Object

com.codename1.rad.models.Attribute<T>

com.codename1.rad.nodes.Node

com.codename1.rad.nodes.FormNode

All Implemented Interfaces:

ActionCategories, Iterable<SectionNode>

public class FormNode
extends Node
implements Iterable<SectionNode>, ActionCategories

A node that encapsulates form (not a Form, a small "f" form) for editing the properties of an Entity. Forms can contain sections (SectionNode), which can contain fields (FieldNode). If fields are added directly to a FormNode, it actually wraps them in an implicit SectionNode which is the "global" section.

Supported Attributes

There isn’t a fixed list of supported attributes, but the following are some of the common attributes you’d find in a form.

1. ActionsNode - Actions to be added at various locations in the form. Can contain multiple ActionsNode attributes.

   1. Categories include: ActionCategories.OVERFLOW_MENU, ActionCategories.BOTTOM_LEFT_MENU, ActionCategories.BOTTOM_RIGHT_MENU, ActionCategories.TOP_LEFT_MENU, ActionCategories.TOP_RIGHT_MENU.

2. SectionNode - Can contain multiple section nodes.

   1. All attributes supported by SectionNode will be accepted by FormNode, as they will be wrapped in an implicit SectionNode which is the global section.

Example

The following is an example of a UI descriptor for editing a "Person" entity.

A UI descriptor for a form to edit a "Person" entity

package com.codename1.demos.ddddemo;

import com.codename1.rad.ui.UI;
import com.codename1.rad.nodes.ActionNode;
import static com.codename1.demos.ddddemo.PersonEntityType.*;
import com.codename1.ui.FontImage;
import static com.codename1.ui.FontImage.MATERIAL_DELETE;
import static com.codename1.rad.nodes.FormNode.OVERFLOW_MENU;
import static com.codename1.rad.nodes.FormNode.BOTTOM_RIGHT_MENU;
import static com.codename1.rad.nodes.FormNode.TOP_LEFT_MENU;


public class PersonEditor extends UI {

   // Define some actions
   public static ActionNode
       deleteAction = action(
           label("Delete"),
           description("Delete this user"),
           icon(MATERIAL_DELETE)
       ),
       showContactsAction = action(
           label("Open Contacts"),
           description("Show all contacts"),
           icon(FontImage.MATERIAL_CONTACTS)
       ),
       printAction = action(
           label("Print"),
           description("Print this page"),
           icon(FontImage.MATERIAL_PRINT)
       );

   {


       // Define the root form.
       form(
           actions(OVERFLOW_MENU, deleteAction, printAction),  (1)
           actions(TOP_LEFT_MENU, deleteAction, printAction, showContactsAction), (2)
           actions(BOTTOM_RIGHT_MENU, deleteAction, printAction), (3)
           editable(true),
           description("Please edit the person's information in the fields below"),
           label("Person Details"),
           columns(2),
           textField(
               label("Name"),
               description("Please enter your name"),
               tags(Person.name)
           ),
           textField(
               tags(description)
           ),
           comboBox(
               tags(DemoTags.hairColor)
           ),
           section(
               actions(TOP_LEFT_MENU, deleteAction, printAction),
               columns(1),
               label("Section 2"),
               textArea(
                   tags(DemoTags.userProfile)
               ),
               table(actions(OVERFLOW_MENU, deleteAction, printAction),
                  label("Quick Links"),
                  description("Useful links related to this person"),
                  editable(true),
                  //property(quicklinks),
                  tags(com.codename1.rad.schemas.Person.url),
                  columns(new QuickLinkEditor().getAllFields())
               )
           )

       );

}}

1. We add an overflow menu to the form.

2. Add some actions to the top-left menu.

3. Add some actions to the bottom-right menu.

Notice how succinct, yet readable this code is. We can convert this into an actual view with the following:

new EntityEditor(entity, new PersonEditor());

And the result:

Figure 1. The UI generated from the above UI descriptor. All fields are bound to the entity, so changes to the entity will instantly update the UI, and vice-versa.

Author:

shannah

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FormNode.Sections

Field Summary

Fields inherited from class com.codename1.rad.nodes.Node

actions, attributes, childNodes, viewParameters

Fields inherited from interface com.codename1.rad.ui.ActionCategories

BOTTOM_LEFT_MENU, BOTTOM_MENU, BOTTOM_RIGHT_MENU, BUTTON_ACTION, LEFT_SWIPE_MENU, LIST_ADD_ACTION, LIST_LOAD_MORE_ACTION, LIST_REFRESH_ACTION, LIST_REMOVE_ACTION, LIST_SELECT_ACTION, OVERFLOW_MENU, RIGHT_SWIPE_MENU, TOP_LEFT_MENU, TOP_MENU, TOP_RIGHT_MENU

Constructor Summary

Constructors

Constructor and Description
FormNode(Attribute... atts)

Method Summary

Modifier and Type	Method and Description
Attribute	findAttribute(Class type) Returns an attribute of the given type for this node.
FieldNode[]	getAllFields()
ListNode	getRootList()
ViewNode	getRootView()
FormNode.Sections	getSections()
Iterator<SectionNode>	iterator()
void	setAttributes(Attribute... atts) Sets attributes on this node.

Methods inherited from class com.codename1.rad.nodes.Node

appendChild, as, canProxy, copyAttributes, copyAttributesIfNotExists, createPropertySelector, findAttributeValue, findInheritedAttribute, findInheritedAttributeValue, getAction, getActions, getAncestor, getCanonicalNode, getChildFieldNodes, getChildNode, getChildNodes, getChildNodes, getDateFormatter, getIconUIID, getInheritedAction, getInheritedActions, getNumberFormatter, getParent, getProxying, getTextFormatter, getUIID, getUIID, getUIID, getUIIDPrefix, getUIIDPrefix, getValue, getViewParameter, getViewParameter, getViewParameterValue, getViewParameterValue, hasViewParameter, isSameNode, merge, mergeRecursive, proxy, proxyingIterator, setAttributes, setAttributesIfNotExists, setParent, setProxying, toString

Methods inherited from class com.codename1.rad.models.Attribute

freeze

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FormNode

public FormNode(Attribute... atts)

Method Detail

findAttribute

public Attribute findAttribute(Class type)

Description copied from class: Node

Returns an attribute of the given type for this node. If this is a proxy node, it will first check its own attributes. If none is found, it will check the node that it is proxying for the attribute.

Overrides:

findAttribute in class Node

Parameters:

type - The attribute type.

Returns:

The attribute, or null, if this node doesn’t have an attribute of this type.

setAttributes

public void setAttributes(Attribute... atts)

Description copied from class: Node

Sets attributes on this node.

Overrides:

setAttributes in class Node

Parameters:

atts - The attributes to set.

iterator

public Iterator<SectionNode> iterator()

Specified by:

iterator in interface Iterable<SectionNode>

getSections

public FormNode.Sections getSections()

getAllFields

public FieldNode[] getAllFields()

getRootList

public ListNode getRootList()

getRootView

public ViewNode getRootView()