Package io.jmix.ui.widget.client.tagfield

Class JmixTagFieldWidget

java.lang.Object

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

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

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

io.jmix.ui.widget.client.suggestionfield.JmixSuggestionFieldWidget

io.jmix.ui.widget.client.tagfield.JmixTagFieldWidget

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllKeyHandlers, 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<JmixSuggestionFieldWidget.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.HasEnabled, 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

public class JmixTagFieldWidget
extends JmixSuggestionFieldWidget

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JmixTagFieldWidget.JmixLayoutTagFieldEvents
protected class	JmixTagFieldWidget.JmixTagFieldEvents	As widget hides in some cases (readOnly, disabled) TextField that handle blur/focus, TagFieldWidget should handle blur/focus itself.
protected class	JmixTagFieldWidget.TagFieldSuggestionPopup

Nested classes/interfaces inherited from class io.jmix.ui.widget.client.suggestionfield.JmixSuggestionFieldWidget

JmixSuggestionFieldWidget.JmixTextFieldEvents, JmixSuggestionFieldWidget.Suggestion, JmixSuggestionFieldWidget.SuggestionPopup, JmixSuggestionFieldWidget.SuggestionTimer

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

Fields

Modifier and Type	Field	Description
static final String	CLASSNAME
static final String	CLEAR_ALL
static final String	CLEAR_ALL_BUTTON
protected com.vaadin.client.ui.VLabel	clearAllBtn
protected boolean	clearAllVisible
protected Runnable	clearItemHandler
protected boolean	clickableTag
static final String	EMPTY
static final String	FOCUS
protected com.google.gwt.user.client.ui.FlowPanel	layout
static final String	LAYOUT
protected FocusableFlowPanel	root
static final String	SINGLELINE
protected static final String	TAG_CAPTION_KEY
protected static final String	TAG_KEY
protected static final String	TAG_STYLE_KEY
protected Consumer<String>	tagClickHandler
protected Map<JmixTagLabelWidget,String>	tagKeyMap
protected Consumer<String>	tagRemoveHandler
static final String	TEXT_OVERFLOW_TAGLABEL

Fields inherited from class io.jmix.ui.widget.client.suggestionfield.JmixSuggestionFieldWidget

arrowDownActionHandler, asyncSearchDelayMs, cancelSearchHandler, enterActionHandler, focused, iePreventBlur, minSearchStringLength, MODIFIED_STYLENAME, popupStylename, popupWidth, prevQuery, searchExecutor, selectFirstSuggestionOnShow, SUGGESTION_CAPTION, SUGGESTION_ID, SUGGESTION_STYLE_NAME, suggestions, suggestionsContainer, suggestionSelectedHandler, suggestionsPopup, suggestionTimer, textField, V_FILTERSELECT_SUGGESTPOPUP, value

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
JmixTagFieldWidget()

Method Summary

Modifier and Type	Method	Description
protected void	addClearAllButton()
protected void	addWindowResizeHandler()
void	clearText()
protected JmixSuggestionFieldWidget.SuggestionPopup	createSuggestionPopup(SuggestionsContainer suggestionsContainer)
protected JmixTagLabelWidget	generateTagLabel(elemental.json.JsonObject json)
Runnable	getClearItemHandler()
Consumer<String>	getTagClickHandler()
Consumer<String>	getTagRemoveHandler()
protected void	handleOnBlur(com.google.gwt.event.dom.client.BlurEvent event)	Handle TextField blur
protected void	handleOnFocus(com.google.gwt.event.dom.client.FocusEvent event)	Handle TextField focus
protected void	initClearAllButton()
protected void	initTextField()
boolean	isClearAllVisible()
boolean	isClickableTag()
protected boolean	isTagLabelExceedFieldWidth(JmixTagLabelWidget label)
protected void	onTagClick(String tagKey)
protected void	onTagRemove(String tagKey)
void	setClearAllVisible(boolean clearAllVisible)
void	setClearItemHandler(Runnable clearItemHandler)
void	setClickableTag(boolean clickableTag)
void	setEnabled(boolean enabled)
void	setItems(List<elemental.json.JsonObject> items)
void	setReadonly(boolean readonly)
void	setTagClickHandler(Consumer<String> tagClickHandler)
void	setTagRemoveHandler(Consumer<String> tagRemoveHandler)
protected void	setupComposition()
boolean	updateWidgetHeightStyle()
protected void	updateWidgetsAvailability()
protected void	updateWidgetsWidth()

Methods inherited from class io.jmix.ui.widget.client.suggestionfield.JmixSuggestionFieldWidget

addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addSelectionHandler, addValueChangeHandler, cancelSearch, disableAutocompletion, getMarginBorderPaddingWidth, getTabIndex, getValue, handleArrowDownKeyPressed, handleArrowUpKeyPressed, handleEnterKeyPressed, handleEscKeyPressed, isActive, isEnabled, isFocused, isReadonly, isSelectFirstSuggestionOnShow, preventEvent, resetComponentState, scheduleQuery, searchSuggestions, selectSuggestion, selectSuggestion, setAccessKey, setAsyncSearchDelayMs, setFocus, setInputPrompt, setMinSearchStringLength, setPopupStyleName, setPopupWidth, setSelectFirstSuggestionOnShow, setTabIndex, setValue, setValue, showSuggestions, showSuggestions

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

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

Field Details

CLASSNAME

public static final String CLASSNAME

See Also:

• Constant Field Values

LAYOUT

public static final String LAYOUT

See Also:

• Constant Field Values

CLEAR_ALL_BUTTON

public static final String CLEAR_ALL_BUTTON

See Also:

• Constant Field Values

FOCUS

public static final String FOCUS

See Also:

• Constant Field Values

EMPTY

public static final String EMPTY

See Also:

• Constant Field Values

CLEAR_ALL

public static final String CLEAR_ALL

See Also:

• Constant Field Values

SINGLELINE

public static final String SINGLELINE

See Also:

• Constant Field Values

TEXT_OVERFLOW_TAGLABEL

public static final String TEXT_OVERFLOW_TAGLABEL

See Also:

• Constant Field Values

TAG_CAPTION_KEY

protected static final String TAG_CAPTION_KEY

See Also:

• Constant Field Values

TAG_STYLE_KEY

protected static final String TAG_STYLE_KEY

See Also:

• Constant Field Values

TAG_KEY

protected static final String TAG_KEY

See Also:

• Constant Field Values

root

protected FocusableFlowPanel root

layout

protected com.google.gwt.user.client.ui.FlowPanel layout

clearAllBtn

protected com.vaadin.client.ui.VLabel clearAllBtn

tagKeyMap

protected Map<JmixTagLabelWidget,String> tagKeyMap

tagClickHandler

protected Consumer<String> tagClickHandler

tagRemoveHandler

protected Consumer<String> tagRemoveHandler

clearItemHandler

protected Runnable clearItemHandler

clickableTag

protected boolean clickableTag

clearAllVisible

protected boolean clearAllVisible

Constructor Details

JmixTagFieldWidget

public JmixTagFieldWidget()

Method Details

setupComposition

protected void setupComposition()

Overrides:

setupComposition in class JmixSuggestionFieldWidget

initTextField

protected void initTextField()

Overrides:

initTextField in class JmixSuggestionFieldWidget

addClearAllButton

protected void addClearAllButton()

initClearAllButton

protected void initClearAllButton()

addWindowResizeHandler

protected void addWindowResizeHandler()

createSuggestionPopup

protected JmixSuggestionFieldWidget.SuggestionPopup createSuggestionPopup(SuggestionsContainer suggestionsContainer)

Overrides:

createSuggestionPopup in class JmixSuggestionFieldWidget

setReadonly

public void setReadonly(boolean readonly)

Overrides:

setReadonly in class JmixSuggestionFieldWidget

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Overrides:

setEnabled in class JmixSuggestionFieldWidget

updateWidgetsAvailability

protected void updateWidgetsAvailability()

getTagClickHandler

@Nullable
public Consumer<String> getTagClickHandler()

setTagClickHandler

public void setTagClickHandler(@Nullable
 Consumer<String> tagClickHandler)

getTagRemoveHandler

@Nullable
public Consumer<String> getTagRemoveHandler()

setTagRemoveHandler

public void setTagRemoveHandler(@Nullable
 Consumer<String> tagRemoveHandler)

isClickableTag

public boolean isClickableTag()

setClickableTag

public void setClickableTag(boolean clickableTag)

getClearItemHandler

public Runnable getClearItemHandler()

setClearItemHandler

public void setClearItemHandler(@Nullable
 Runnable clearItemHandler)

isClearAllVisible

public boolean isClearAllVisible()

setClearAllVisible

public void setClearAllVisible(boolean clearAllVisible)

clearText

public void clearText()

setItems

public void setItems(@Nullable
 List<elemental.json.JsonObject> items)

generateTagLabel

protected JmixTagLabelWidget generateTagLabel(elemental.json.JsonObject json)

onTagClick

protected void onTagClick(String tagKey)

onTagRemove

protected void onTagRemove(String tagKey)

updateWidgetHeightStyle

public boolean updateWidgetHeightStyle()

updateWidgetsWidth

protected void updateWidgetsWidth()

isTagLabelExceedFieldWidth

protected boolean isTagLabelExceedFieldWidth(JmixTagLabelWidget label)

handleOnBlur

protected void handleOnBlur(com.google.gwt.event.dom.client.BlurEvent event)

Handle TextField blur

Overrides:

handleOnBlur in class JmixSuggestionFieldWidget

Parameters:

event - blur event

handleOnFocus

protected void handleOnFocus(com.google.gwt.event.dom.client.FocusEvent event)

Handle TextField focus

Overrides:

handleOnFocus in class JmixSuggestionFieldWidget

Parameters:

event - focus event