Package de.knightsoftnet.mtwidgets.client.ui.widget

Class SuggestBoxWithEditorErrors

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.google.gwt.user.client.ui.AbstractSuggestBoxNewEditor

de.knightsoftnet.mtwidgets.client.ui.widget.SuggestBoxNewEditor

de.knightsoftnet.mtwidgets.client.ui.widget.SuggestBoxWithEditorErrors

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasSelectionHandlers<com.google.gwt.user.client.ui.SuggestOracle.Suggestion>, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<String>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, HasAutocomplete, HasAutofocus, HasPlaceholder, HasRequired, HasValidationMessageElement<String,org.gwtproject.editor.client.LeafValueEditor<String>>, HasValidity, org.gwtproject.editor.client.Editor<String>, org.gwtproject.editor.client.HasEditorErrors<String>, org.gwtproject.editor.client.IsEditor<org.gwtproject.editor.client.LeafValueEditor<String>>, org.gwtproject.editor.client.TakesValue<String>

Direct Known Subclasses:

AbstractFormatingSuggestBox, BicSuggestBox

public class SuggestBoxWithEditorErrors
extends SuggestBoxNewEditor
implements com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, HasValidationMessageElement<String,org.gwtproject.editor.client.LeafValueEditor<String>>, HasRequired, HasValidity, HasAutofocus, HasPlaceholder, HasAutocomplete

Text input box with suggestions and editor error handling.

Nested Class Summary

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

AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay, AbstractSuggestBoxNewEditor.SuggestionCallback, AbstractSuggestBoxNewEditor.SuggestionDisplay

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 org.gwtproject.editor.client.Editor

org.gwtproject.editor.client.Editor.Ignore, org.gwtproject.editor.client.Editor.Path

Field Summary

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

callback, currentText, display, limit, oracle, selectsFirstItem, STYLENAME_DEFAULT

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
SuggestBoxWithEditorErrors()	Constructor for SuggestBox.
SuggestBoxWithEditorErrors(com.google.gwt.user.client.ui.SuggestOracle oracle)	Constructor for SuggestBox.
SuggestBoxWithEditorErrors(com.google.gwt.user.client.ui.SuggestOracle oracle, ValueBoxBaseWithEditorErrors<String> box)	Constructor for SuggestBox.
SuggestBoxWithEditorErrors(com.google.gwt.user.client.ui.SuggestOracle oracle, ValueBoxBaseWithEditorErrors<String> box, AbstractSuggestBoxNewEditor.SuggestionDisplay suggestDisplay)	Constructor for SuggestBox.

Method Summary

Modifier and Type	Method	Description
com.google.gwt.event.shared.HandlerRegistration	addBlurHandler(com.google.gwt.event.dom.client.BlurHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
boolean	checkValidity()	Returns false if the element is a candidate for constraint validation, and it does not satisfy its constraints.
String	getAutocomplete()	get autocomplete attribute value.
String	getPlaceholder()	get place holder text.
String	getValidationMessage()	A localized message that describes the validation constraints that the control does not satisfy (if any).
com.google.gwt.user.client.ui.HTMLPanel	getValidationMessageElement()	get validation message element.
elemental2.dom.ValidityState	getValidity()	The validity states that this element is in.
boolean	isAutofocus()	get autofocus value.
boolean	isRequired()	Reflects the required HTML attribute, indicating that the user must fill in a value before submitting a form.
void	setAutocomplete(String arg)	set autocomplete attribute value.
void	setAutofocus(boolean arg)	set autofocus value.
void	setCustomValidity(String message)	set custom validity value.
void	setPlaceholder(String placeholder)	set place holder text.
void	setRequired(boolean arg)	Reflects the required HTML attribute, indicating that the user must fill in a value before submitting a form.
void	setValidationMessageElement(com.google.gwt.user.client.ui.HTMLPanel element)	set validation message element.

Methods inherited from class de.knightsoftnet.mtwidgets.client.ui.widget.SuggestBoxNewEditor

addEventsToTextBox, asEditor, getBoxAsFoucsWidget, getTabIndex, getText, getValue, getValueBox, isEnabled, setAccessKey, setEnabled, setFocus, setTabIndex, setText, setValue, setValue, wrap

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

addEventsToTextBox, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addSelectionHandler, addValueChangeHandler, getLimit, getSuggestionDisplay, getSuggestOracle, hideSuggestionList, isAnimationEnabled, isAutoSelectEnabled, isSuggestionListShowing, onEnsureDebugId, refreshSuggestionList, setAnimationEnabled, setAutoSelectEnabled, setLimit, setOracle, setPopupStyleName, showSuggestionList

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, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface de.knightsoftnet.mtwidgets.client.ui.widget.features.HasValidationMessageElement

editorErrorMatches, setTitle, showErrors, showErrors

Methods inherited from interface org.gwtproject.editor.client.IsEditor

asEditor

Constructor Details

SuggestBoxWithEditorErrors

public SuggestBoxWithEditorErrors()

Constructor for SuggestBox. Creates a MultiWordSuggestOracle and TextBox to use with this SuggestBox.

SuggestBoxWithEditorErrors

public SuggestBoxWithEditorErrors(com.google.gwt.user.client.ui.SuggestOracle oracle)

Constructor for SuggestBox. Creates a TextBox to use with this SuggestBox.

Parameters:

oracle - the oracle for this SuggestBox

SuggestBoxWithEditorErrors

public SuggestBoxWithEditorErrors(com.google.gwt.user.client.ui.SuggestOracle oracle,
 ValueBoxBaseWithEditorErrors<String> box)

Constructor for SuggestBox. The text box will be removed from it's current location and wrapped by the SuggestBox.

Parameters:

oracle - supplies suggestions based upon the current contents of the text widget

box - the text widget

SuggestBoxWithEditorErrors

public SuggestBoxWithEditorErrors(com.google.gwt.user.client.ui.SuggestOracle oracle,
 ValueBoxBaseWithEditorErrors<String> box,
 AbstractSuggestBoxNewEditor.SuggestionDisplay suggestDisplay)

Constructor for SuggestBox. The text box will be removed from it's current location and wrapped by the SuggestBox.

Parameters:

oracle - supplies suggestions based upon the current contents of the text widget

box - the text widget

suggestDisplay - the class used to display suggestions

Method Details

addBlurHandler

public com.google.gwt.event.shared.HandlerRegistration addBlurHandler(com.google.gwt.event.dom.client.BlurHandler handler)

Specified by:

addBlurHandler in interface com.google.gwt.event.dom.client.HasBlurHandlers

addFocusHandler

public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)

Specified by:

addFocusHandler in interface com.google.gwt.event.dom.client.HasFocusHandlers

getValidationMessage

public String getValidationMessage()

Description copied from interface: HasValidity

A localized message that describes the validation constraints that the control does not satisfy (if any). This is the empty string if the control is not a candidate for constraint validation (willValidate is false), or it satisfies its constraints.

Specified by:

getValidationMessage in interface HasValidity

Returns:

localized validation message

getValidity

public elemental2.dom.ValidityState getValidity()

Description copied from interface: HasValidity

The validity states that this element is in.

Specified by:

getValidity in interface HasValidity

Returns:

ValidityState

checkValidity

public boolean checkValidity()

Description copied from interface: HasValidity

Returns false if the element is a candidate for constraint validation, and it does not satisfy its constraints. In this case, it also fires an invalid event at the element. It returns true if the element is not a candidate for constraint validation, or if it satisfies its constraints.

Specified by:

checkValidity in interface HasValidity

Returns:

true if input is valid

isRequired

public boolean isRequired()

Description copied from interface: HasRequired

Reflects the required HTML attribute, indicating that the user must fill in a value before submitting a form.

Specified by:

isRequired in interface HasRequired

Returns:

required true/false

setRequired

public void setRequired(boolean arg)

Description copied from interface: HasRequired

Reflects the required HTML attribute, indicating that the user must fill in a value before submitting a form.

Specified by:

setRequired in interface HasRequired

Parameters:

arg - required true/false

isAutofocus

public boolean isAutofocus()

Description copied from interface: HasAutofocus

get autofocus value.

Specified by:

isAutofocus in interface HasAutofocus

Returns:

true if input field has autofocus

setAutofocus

public void setAutofocus(boolean arg)

Description copied from interface: HasAutofocus

set autofocus value.

Specified by:

setAutofocus in interface HasAutofocus

Parameters:

arg - true if input field has autofocus

setValidationMessageElement

public void setValidationMessageElement(com.google.gwt.user.client.ui.HTMLPanel element)

Description copied from interface: HasValidationMessageElement

set validation message element.

Specified by:

setValidationMessageElement in interface HasValidationMessageElement<String,org.gwtproject.editor.client.LeafValueEditor<String>>

Parameters:

element - element to set

getValidationMessageElement

public com.google.gwt.user.client.ui.HTMLPanel getValidationMessageElement()

Description copied from interface: HasValidationMessageElement

get validation message element.

Specified by:

getValidationMessageElement in interface HasValidationMessageElement<String,org.gwtproject.editor.client.LeafValueEditor<String>>

Returns:

element or null if non is set

getPlaceholder

public String getPlaceholder()

Description copied from interface: HasPlaceholder

get place holder text.

Specified by:

getPlaceholder in interface HasPlaceholder

Returns:

place holder text displayed when value is empty

setPlaceholder

public void setPlaceholder(String placeholder)

Description copied from interface: HasPlaceholder

set place holder text.

Specified by:

setPlaceholder in interface HasPlaceholder

Parameters:

placeholder - place holder text displayed when value is empty

getAutocomplete

public String getAutocomplete()

Description copied from interface: HasAutocomplete

get autocomplete attribute value.

Specified by:

getAutocomplete in interface HasAutocomplete

Returns:

input field autocomplete attribute value

setAutocomplete

public void setAutocomplete(String arg)

Description copied from interface: HasAutocomplete

set autocomplete attribute value.

Specified by:

setAutocomplete in interface HasAutocomplete

Parameters:

arg - input field autocomplete attribute value to set

setCustomValidity

public void setCustomValidity(String message)

Description copied from interface: HasValidationMessageElement

set custom validity value.

Specified by:

setCustomValidity in interface HasValidationMessageElement<String,org.gwtproject.editor.client.LeafValueEditor<String>>

Parameters:

message - message to show