org.jboss.hal.core.mbui.form

Class ModelNodeForm.Builder<T extends ModelNode>

java.lang.Object

org.jboss.hal.core.mbui.form.ModelNodeForm.Builder<T>

Enclosing class:

ModelNodeForm<T extends ModelNode>

@JsType(namespace="hal.ui",
        name="FormBuilder")
public static class ModelNodeForm.Builder<T extends ModelNode>
extends Object

Builder to create forms based on resource metadata. By default the form includes all non-deprecated attributes with "storage" => "configuration".

Constructor Summary

Constructors

Constructor and Description
Builder(String id, Metadata metadata)

Method Summary

Modifier and Type	Method and Description
ModelNodeForm.Builder<T>	addOnly() Use this flag if you just want to use the form to add model nodes.
ModelNodeForm<T>	build() Creates and returns the form.
ModelNodeForm.Builder<T>	customFormItem(String attribute, FormItemProvider provider)
ModelNodeForm.Builder<T>	exclude(Iterable<String> attributes)
ModelNodeForm.Builder<T>	exclude(String[] attributes)
ModelNodeForm.Builder<T>	exclude(String first, String... rest)
ModelNodeForm.Builder<T>	fromRequestProperties() Use this flag if you just want to use the form to add model nodes.
ModelNodeForm.Builder<T>	include(Iterable<String> attributes)
ModelNodeForm.Builder<T>	include(String[] attributes)
ModelNodeForm.Builder<T>	include(String first, String... rest)
ModelNodeForm.Builder<T>	includeRuntime() Includes also attributes with "storage" => "runtime"
ModelNodeForm.Builder<T>	jsExclude(String[] attributes) Excludes the specified attributes
ModelNodeForm.Builder<T>	jsInclude(String[] attributes) Includes the specified attributes
ModelNodeForm.Builder<T>	jsOnSave(org.jboss.hal.core.mbui.form.ModelNodeForm.Builder.JsSaveCallback<T> callback) Calls the specified callback when the save button was clicked and no validation errors occurred.
ModelNodeForm.Builder<T>	onCancel(Form.CancelCallback<T> cancelCallback)
ModelNodeForm.Builder<T>	onSave(Form.SaveCallback<T> saveCallback)
ModelNodeForm.Builder<T>	panelForOptionalAttributes() By default the non-requried attributes are displayed together with the required attributes.
ModelNodeForm.Builder<T>	prepareRemove(Form.PrepareRemove<T> removeCallback)
ModelNodeForm.Builder<T>	prepareReset(Form.PrepareReset<T> prepareReset)
ModelNodeForm.Builder<T>	readOnly() Makes the form read-only.
ModelNodeForm.Builder<T>	requiredOnly() Includes only required attributes
ModelNodeForm.Builder<T>	showDeprecated() Includes also deprecated attributes
ModelNodeForm.Builder<T>	singleton(Supplier<Operation> ping, Callback addAction) Use this method if you want to manage a singleton resource.
ModelNodeForm.Builder<T>	singleton(Supplier<Operation> ping, EmptyState emptyState) Use this method if you want to manage a singleton resource.
ModelNodeForm.Builder<T>	unboundFormItem(FormItem formItem)
ModelNodeForm.Builder<T>	unboundFormItem(FormItem formItem, int position)
ModelNodeForm.Builder<T>	unboundFormItem(FormItem formItem, int position, com.google.gwt.safehtml.shared.SafeHtml helpText)
ModelNodeForm.Builder<T>	unsorted() Doesn't sort the attributes alphabetically.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

@JsIgnore
public Builder(@NonNls
                         String id,
                         Metadata metadata)

Method Detail

include

@JsIgnore
public ModelNodeForm.Builder<T> include(String[] attributes)

include

@JsIgnore
public ModelNodeForm.Builder<T> include(Iterable<String> attributes)

include

@JsIgnore
public ModelNodeForm.Builder<T> include(@NonNls
                                                  String first,
                                                  @NonNls
                                                  String... rest)

exclude

@JsIgnore
public ModelNodeForm.Builder<T> exclude(String[] attributes)

exclude

@JsIgnore
public ModelNodeForm.Builder<T> exclude(Iterable<String> attributes)

exclude

@JsIgnore
public ModelNodeForm.Builder<T> exclude(@NonNls
                                                  String first,
                                                  @NonNls
                                                  String... rest)

addOnly

public ModelNodeForm.Builder<T> addOnly()

Use this flag if you just want to use the form to add model nodes. The attributes will be taken from the ATTRIBUTES child node.

fromRequestProperties

public ModelNodeForm.Builder<T> fromRequestProperties()

Use this flag if you just want to use the form to add model nodes. The attributes will be taken from the REQUEST_PROPERTIES node of the ADD operation.

readOnly

public ModelNodeForm.Builder<T> readOnly()

Makes the form read-only.

unsorted

public ModelNodeForm.Builder<T> unsorted()

Doesn't sort the attributes alphabetically.

requiredOnly

public ModelNodeForm.Builder<T> requiredOnly()

Includes only required attributes

includeRuntime

public ModelNodeForm.Builder<T> includeRuntime()

Includes also attributes with "storage" => "runtime"

showDeprecated

public ModelNodeForm.Builder<T> showDeprecated()

Includes also deprecated attributes

singleton

@JsIgnore
public ModelNodeForm.Builder<T> singleton(Supplier<Operation> ping,
                                                    Callback addAction)

Use this method if you want to manage a singleton resource. This will create a form with an SingletonStateMachine.

The specified operation is used to check whether the resource exists.

If the resource does not exist, a default empty state is displayed. The empty state will contain a button which will trigger the specified add action.

singleton

@JsIgnore
public ModelNodeForm.Builder<T> singleton(Supplier<Operation> ping,
                                                    EmptyState emptyState)

Use this method if you want to manage a singleton resource. This will create a form with an SingletonStateMachine.

The specified operation is used to check whether the resource exists.

If the resource does not exist, the specified empty state is displayed. The empty state must have a button which triggers the creation of the singleton resource.

Please make sure that the primary action of the empty state has a constraint attached to it.

customFormItem

@JsIgnore
public ModelNodeForm.Builder<T> customFormItem(@NonNls
                                                         String attribute,
                                                         FormItemProvider provider)

unboundFormItem

@JsIgnore
public ModelNodeForm.Builder<T> unboundFormItem(FormItem formItem)

unboundFormItem

@JsIgnore
public ModelNodeForm.Builder<T> unboundFormItem(FormItem formItem,
                                                          int position)

unboundFormItem

@JsIgnore
public ModelNodeForm.Builder<T> unboundFormItem(FormItem formItem,
                                                          int position,
                                                          com.google.gwt.safehtml.shared.SafeHtml helpText)

onSave

@JsIgnore
public ModelNodeForm.Builder<T> onSave(Form.SaveCallback<T> saveCallback)

onCancel

@JsIgnore
public ModelNodeForm.Builder<T> onCancel(Form.CancelCallback<T> cancelCallback)

prepareReset

@JsIgnore
public ModelNodeForm.Builder<T> prepareReset(Form.PrepareReset<T> prepareReset)

prepareRemove

@JsIgnore
public ModelNodeForm.Builder<T> prepareRemove(Form.PrepareRemove<T> removeCallback)

panelForOptionalAttributes

@JsIgnore
public ModelNodeForm.Builder<T> panelForOptionalAttributes()

By default the non-requried attributes are displayed together with the required attributes. Call this method to put the non-required attributes on a collapsible panel beneath the required attributes.

build

public ModelNodeForm<T> build()

Creates and returns the form.

jsInclude

@JsMethod(name="include")
public ModelNodeForm.Builder<T> jsInclude(String[] attributes)

Includes the specified attributes

jsExclude

@JsMethod(name="exclude")
public ModelNodeForm.Builder<T> jsExclude(String[] attributes)

Excludes the specified attributes

jsOnSave

@JsMethod(name="onSave")
public ModelNodeForm.Builder<T> jsOnSave(org.jboss.hal.core.mbui.form.ModelNodeForm.Builder.JsSaveCallback<T> callback)

Calls the specified callback when the save button was clicked and no validation errors occurred.