com.github.gwtbootstrap.client.ui
Class Form

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Panel
              com.google.gwt.user.client.ui.ComplexPanel
                  com.github.gwtbootstrap.client.ui.base.ComplexWidget
                      com.github.gwtbootstrap.client.ui.Form

All Implemented Interfaces:

HasStyle, IsResponsive, HasAttachHandlers, HasHandlers, EventListener, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.impl.FormPanelImplHost, IndexedPanel, IndexedPanel.ForIsWidget, IsWidget, Iterable<Widget>

Direct Known Subclasses:

NavFormBase, WellForm

public class Form
extends ComplexWidget
implements com.google.gwt.user.client.ui.impl.FormPanelImplHost

Styled HTML form.

UiBinder Usage:

 <b:Form>...</b:Form>
 

Since:

2.0.4.0

Author:

Dominik Mayer, ohashi keisuke

Nested Class Summary

static class	Form.SubmitCompleteEvent Fired when a form has been submitted successfully.
static interface	Form.SubmitCompleteHandler Handler for Form.SubmitCompleteEvent events.
static class	Form.SubmitEvent Fired when the form is submitted.
static interface	Form.SubmitHandler Handler for Form.SubmitEvent events.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

HasWidgets.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

IndexedPanel.ForIsWidget

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	Form() Creates an empty form.
	Form(boolean createIFrame)
protected	Form(Element element, boolean createIFrame) This constructor may be used by subclasses to explicitly use an existing element.

Method Summary

HandlerRegistration	addSubmitCompleteHandler(Form.SubmitCompleteHandler handler) Adds a Form.SubmitCompleteEvent handler.
HandlerRegistration	addSubmitHandler(Form.SubmitHandler handler) Adds a Form.SubmitEvent handler.
String	getAction() Gets the 'action' associated with this form.
String	getEncoding() Gets the encoding used for submitting this form.
String	getMethod() Gets the HTTP method used for submitting this form.
String	getTarget()
protected void	onAttach()
protected void	onDetach()
boolean	onFormSubmit()
void	onFrameLoad()
void	reset() Resets the form, clearing all fields.
void	setAction(SafeUri url) Sets the 'action' associated with this form.
void	setAction(String url) Sets the 'action' associated with this form.
void	setEncoding(String encodingType) Sets the encoding used for submitting this form.
void	setMethod(String method) Sets the HTTP method used for submitting this form.
void	setTarget(String target)
void	setType(FormType type) Sets the type of the form.
void	submit() Submits the form.

Methods inherited from class com.github.gwtbootstrap.client.ui.base.ComplexWidget

add, addStyle, insert, removeStyle, setHideOn, setShowOn, setStyle

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.user.client.ui.HasWidgets

clear, iterator, remove

Constructor Detail

Form

public Form()

Creates an empty form.

Form

public Form(boolean createIFrame)

Form

protected Form(Element element,
               boolean createIFrame)

This constructor may be used by subclasses to explicitly use an existing element. This element must be a <form> element.

If the createIFrame parameter is set to true, then the wrapped form's target attribute will be set to a hidden iframe. If not, the form's target will be left alone, and the FormSubmitComplete event will not be fired.

Parameters:

element - the element to be used

createIFrame - true to create an <iframe> element that will be targeted by this form

Method Detail

addSubmitCompleteHandler

public HandlerRegistration addSubmitCompleteHandler(Form.SubmitCompleteHandler handler)

Adds a Form.SubmitCompleteEvent handler.

Parameters:

handler - the handler

Returns:

the handler registration used to remove the handler

addSubmitHandler

public HandlerRegistration addSubmitHandler(Form.SubmitHandler handler)

Adds a Form.SubmitEvent handler.

Parameters:

handler - the handler

Returns:

the handler registration used to remove the handler

getAction

public String getAction()

Gets the 'action' associated with this form. This is the URL to which it will be submitted.

Returns:

the form's action

getEncoding

public String getEncoding()

Gets the encoding used for submitting this form. This should be either #ENCODING_MULTIPART or #ENCODING_URLENCODED.

Returns:

the form's encoding

getMethod

public String getMethod()

Gets the HTTP method used for submitting this form. This should be either #METHOD_GET or #METHOD_POST.

Returns:

the form's method

getTarget

public String getTarget()

setType

public void setType(FormType type)

Sets the type of the form.

Parameters:

type - the form's type

reset

public void reset()

Resets the form, clearing all fields.

setAction

public void setAction(String url)

Sets the 'action' associated with this form. This is the URL to which it will be submitted.

Parameters:

url - the form's action

setAction

public void setAction(SafeUri url)

Sets the 'action' associated with this form. This is the URL to which it will be submitted.

Parameters:

url - the form's action

setEncoding

public void setEncoding(String encodingType)

Sets the encoding used for submitting this form. This should be either #ENCODING_MULTIPART or #ENCODING_URLENCODED.

Parameters:

encodingType - the form's encoding

setMethod

public void setMethod(String method)

Sets the HTTP method used for submitting this form. This should be either #METHOD_GET or #METHOD_POST.

Parameters:

method - the form's method

submit

public void submit()

Submits the form.

The FormPanel must not be detached (i.e. removed from its parent or otherwise disconnected from a RootPanel) until the submission is complete. Otherwise, notification of submission will fail.

onAttach

protected void onAttach()

Overrides:

onAttach in class Widget

onDetach

protected void onDetach()

Overrides:

onDetach in class Widget

setTarget

public void setTarget(String target)

onFormSubmit

public boolean onFormSubmit()

Specified by:

onFormSubmit in interface com.google.gwt.user.client.ui.impl.FormPanelImplHost

onFrameLoad

public void onFrameLoad()

Specified by:

onFrameLoad in interface com.google.gwt.user.client.ui.impl.FormPanelImplHost