Class A_CmsFormFieldPanel
java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Composite
org.opencms.gwt.client.ui.input.form.A_CmsFormFieldPanel
- 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.IsRenderable
,com.google.gwt.user.client.ui.IsWidget
- Direct Known Subclasses:
CmsFieldsetFormFieldPanel
,CmsInfoBoxFormFieldPanel
,CmsPropertyPanel
,CmsSimpleFormFieldPanel
,CmsUserSettingsFormFieldPanel
The abstract class for form field container widgets.
- Since:
- 8.0.0
-
Nested Class Summary
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
-
Field Summary
Modifier and TypeFieldDescriptionprotected CmsListItemWidget
The info widget.static final String
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected CmsFormRow
Creates a form row.protected CmsFormRow
createRow
(String labelText, String description, com.google.gwt.user.client.ui.Widget widget, String infoText, boolean infoIsHtml) Adds a new row with a given label and input widget to the form.protected CmsFormRow
createRow
(I_CmsFormField field) Helper method for creating a form row widget.abstract String
Returns the default group name.Returns the info widget.abstract void
renderFields
(Collection<I_CmsFormField> fields) Renders a collection of fields.void
rerenderFields
(String group, Collection<I_CmsFormField> fieldsInGroup) Re-renders the fields of a group.protected void
setBorder
(com.google.gwt.user.client.ui.Widget widget) Helper method for adding a border to a widget.Methods inherited from class com.google.gwt.user.client.ui.Composite
claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
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, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
-
Field Details
-
NO_DESCRIPTION
- See Also:
-
m_infoWidget
The info widget.
-
-
Constructor Details
-
A_CmsFormFieldPanel
public A_CmsFormFieldPanel()
-
-
Method Details
-
getDefaultGroup
Returns the default group name.- Returns:
- the default group name
-
getInfoWidget
Returns the info widget.- Returns:
- the info widget
-
renderFields
Renders a collection of fields.This should only be called once, when the form is being built.
- Parameters:
fields
- the fields to render
-
rerenderFields
Re-renders the fields of a group.Not supported by all subclasses.
- Parameters:
group
- the group whose fields to re-renderfieldsInGroup
- the fields to re-render
-
createRow
Helper method for creating a form row widget.- Parameters:
field
- the field for which to create a form row- Returns:
- the newly created form row
-
createRow
protected CmsFormRow createRow(String labelText, String description, com.google.gwt.user.client.ui.Widget widget) Creates a form row.- Parameters:
labelText
- the label textdescription
- the descriptionwidget
- the widget to use- Returns:
- the new form row
-
createRow
protected CmsFormRow createRow(String labelText, String description, com.google.gwt.user.client.ui.Widget widget, String infoText, boolean infoIsHtml) Adds a new row with a given label and input widget to the form.- Parameters:
labelText
- the label text for the form fielddescription
- the description of the form fieldwidget
- the widget for the form fieldinfoText
- the text to display on the info icon (may be null)infoIsHtml
- true if the info text should be interpreted as HTML rather than plain text- Returns:
- the newly added form row
-
setBorder
Helper method for adding a border to a widget.- Parameters:
widget
- the widget which a border should be added to
-