Package com.opencloud.rem.client.ui

Class FormField

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.opencloud.rem.client.ui.FormField

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, MessageDisplay, Iterable<com.google.gwt.user.client.ui.Widget>

public class FormField
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, MessageDisplay

UI wrapper for form field widgets.

Provides required indicator, message display, and help display (using FieldHelpView).

Example use in UIBinder template:

 <ems:FormField ui:field="exampleFieldPanel" required="true">
   <g:TextBox ui:field="exampleField"/>
 </ems:FormField>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FormField.FormFieldConstants
static interface	FormField.Resources
static interface	FormField.Style

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

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

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

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Nested classes/interfaces inherited from interface com.opencloud.rem.client.ui.MessageDisplay

MessageDisplay.MessageSeverity

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
FormField()
FormField(com.google.gwt.user.client.ui.Widget widget)
FormField(FormField.Resources resources)

Method Summary

Modifier and Type	Method	Description
void	add(com.google.gwt.user.client.ui.IsWidget w)
void	add(com.google.gwt.user.client.ui.Widget w)
void	clear()
void	clearMessage()	Clears the message.
void	displayMessage(String message, MessageDisplay.MessageSeverity severity)	Displays a message with the specified severity.
com.google.gwt.user.client.ui.Widget	getFieldWidget()
Iterator<com.google.gwt.user.client.ui.Widget>	iterator()
boolean	remove(com.google.gwt.user.client.ui.IsWidget w)
boolean	remove(com.google.gwt.user.client.ui.Widget w)
FormField	required()
void	setHelp(com.google.gwt.safehtml.shared.SafeHtml helpContent)
void	setHelpView(FieldHelpView fieldHelpView)
void	setRequired(boolean required)

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

claimElement, initializeClaimedElement, isAttached, onBrowserEvent, render, render

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, fireEvent, getLayoutData, getParent, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FormField

public FormField()

FormField

public FormField(com.google.gwt.user.client.ui.Widget widget)

FormField

public FormField(FormField.Resources resources)

Method Detail

setRequired

public void setRequired(boolean required)

required

public FormField required()

setHelpView

public void setHelpView(FieldHelpView fieldHelpView)

setHelp

public void setHelp(com.google.gwt.safehtml.shared.SafeHtml helpContent)

displayMessage

public void displayMessage(String message,
                           MessageDisplay.MessageSeverity severity)

Description copied from interface: MessageDisplay

Displays a message with the specified severity.

Specified by:

displayMessage in interface MessageDisplay

Parameters:

message - the message to be displayed

severity - the severity of the message

clearMessage

public void clearMessage()

Description copied from interface: MessageDisplay

Clears the message.

Specified by:

clearMessage in interface MessageDisplay

add

public void add(com.google.gwt.user.client.ui.Widget w)

Specified by:

add in interface com.google.gwt.user.client.ui.HasWidgets

add

public void add(com.google.gwt.user.client.ui.IsWidget w)

Specified by:

add in interface com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

clear

public void clear()

Specified by:

clear in interface com.google.gwt.user.client.ui.HasWidgets

iterator

public Iterator<com.google.gwt.user.client.ui.Widget> iterator()

Specified by:

iterator in interface com.google.gwt.user.client.ui.HasWidgets

Specified by:

iterator in interface Iterable<com.google.gwt.user.client.ui.Widget>

remove

public boolean remove(com.google.gwt.user.client.ui.Widget w)

Specified by:

remove in interface com.google.gwt.user.client.ui.HasWidgets

remove

public boolean remove(com.google.gwt.user.client.ui.IsWidget w)

Specified by:

remove in interface com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

getFieldWidget

public com.google.gwt.user.client.ui.Widget getFieldWidget()