public class FormField extends Composite implements 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>
Modifier and Type | Class and Description |
---|---|
static interface |
FormField.FormFieldConstants |
static interface |
FormField.Resources |
static interface |
FormField.Style |
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
HasWidgets.ForIsWidget
MessageDisplay.MessageSeverity
DEBUG_ID_PREFIX
Constructor and Description |
---|
FormField() |
FormField(FormField.Resources resources) |
FormField(Widget widget) |
Modifier and Type | Method and Description |
---|---|
void |
add(IsWidget w) |
void |
add(Widget w) |
void |
clear() |
void |
clearMessage()
Clears the message.
|
void |
displayMessage(String message,
MessageDisplay.MessageSeverity severity)
Displays a message with the specified severity.
|
Widget |
getFieldWidget() |
Iterator<Widget> |
iterator() |
boolean |
remove(IsWidget w) |
boolean |
remove(Widget w) |
FormField |
required() |
void |
setHelp(SafeHtml helpContent) |
void |
setHelpView(FieldHelpView fieldHelpView) |
void |
setRequired(boolean required) |
claimElement, initializeClaimedElement, isAttached, onBrowserEvent, render, render
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, fireEvent, getLayoutData, getParent, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
forEach, spliterator
public FormField()
public FormField(Widget widget)
public FormField(FormField.Resources resources)
public void setRequired(boolean required)
public FormField required()
public void setHelpView(FieldHelpView fieldHelpView)
public void setHelp(SafeHtml helpContent)
public void displayMessage(String message, MessageDisplay.MessageSeverity severity)
MessageDisplay
displayMessage
in interface MessageDisplay
message
- the message to be displayedseverity
- the severity of the messagepublic void clearMessage()
MessageDisplay
clearMessage
in interface MessageDisplay
public void add(Widget w)
add
in interface HasWidgets
public void add(IsWidget w)
add
in interface HasWidgets.ForIsWidget
public void clear()
clear
in interface HasWidgets
public Iterator<Widget> iterator()
iterator
in interface HasWidgets
iterator
in interface Iterable<Widget>
public boolean remove(Widget w)
remove
in interface HasWidgets
public boolean remove(IsWidget w)
remove
in interface HasWidgets.ForIsWidget
public Widget getFieldWidget()