io.apiman.manager.ui.client.local.widgets

Class InlineEditableLabel

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

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

io.apiman.manager.ui.client.local.widgets.InlineEditableLabel

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, 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.HasValue<String>, 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.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, MouseInEvent.HasMouseInHandlers, MouseOutEvent.HasMouseOutHandlers, Iterable<com.google.gwt.user.client.ui.Widget>

@Dependent
public class InlineEditableLabel
extends com.google.gwt.user.client.ui.FlowPanel
implements com.google.gwt.user.client.ui.HasValue<String>, MouseInEvent.HasMouseInHandlers, MouseOutEvent.HasMouseOutHandlers

A label that supports inline editing of the value. Can be enabled or disabled, which is useful when the user doesn't have permission to change the value. When disabled, this widget acts just like a label. When enabled, the user may hover over the text and options to inline-edit the value will appear. For this widget to work it must be injected by Errai, so that the appropriate event handlers can be set up during the @PostConstruct phase.

Author:

eric.wittmann@redhat.com

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

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

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

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

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

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
InlineEditableLabel() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addMouseInHandler(MouseInEvent.Handler handler) Adds an ok/cancel handler to the widget.
com.google.gwt.event.shared.HandlerRegistration	addMouseOutHandler(MouseOutEvent.Handler handler) Adds an ok/cancel handler to the widget.
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
protected void	closeEditWidget() Closes the edit fields and reverts back to the standard view.
String	getEmptyValueMessage()
String	getValue()
protected void	onEditClicked() Called when the user clicks to edit the value.
protected void	removeOverlay() Immediately removes the overlay.
void	setEmptyValueMessage(String emptyValueMessage)
void	setEnabled(boolean enabled)
void	setValue(String value)
void	setValue(String value, boolean fireEvents)
protected void	showOverlay() Create and show an overlay.

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

add, clear, insert, insert

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

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

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

add, adopt, adopt, disown, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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

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 com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Constructor Detail

InlineEditableLabel

public InlineEditableLabel()

Constructor.

Method Detail

closeEditWidget

protected void closeEditWidget()

Closes the edit fields and reverts back to the standard view.

removeOverlay

protected void removeOverlay()

Immediately removes the overlay.

showOverlay

protected void showOverlay()

Create and show an overlay.

onEditClicked

protected void onEditClicked()

Called when the user clicks to edit the value.

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - the enabled to set

addValueChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)

Specified by:

addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>

See Also:

HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)

getValue

public String getValue()

Specified by:

getValue in interface com.google.gwt.user.client.TakesValue<String>

Specified by:

getValue in interface com.google.gwt.user.client.ui.HasValue<String>

See Also:

HasValue.getValue()

setValue

public void setValue(String value)

Specified by:

setValue in interface com.google.gwt.user.client.TakesValue<String>

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<String>

See Also:

HasValue.setValue(java.lang.Object)

setValue

public void setValue(String value,
            boolean fireEvents)

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<String>

See Also:

HasValue.setValue(java.lang.Object, boolean)

getEmptyValueMessage

public String getEmptyValueMessage()

Returns:

the emptyValueMessage

setEmptyValueMessage

public void setEmptyValueMessage(String emptyValueMessage)

Parameters:

emptyValueMessage - the emptyValueMessage to set

addMouseOutHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseOutHandler(MouseOutEvent.Handler handler)

Description copied from interface: MouseOutEvent.HasMouseOutHandlers

Adds an ok/cancel handler to the widget.

Specified by:

addMouseOutHandler in interface MouseOutEvent.HasMouseOutHandlers

See Also:

MouseOutEvent.HasMouseOutHandlers.addMouseOutHandler(io.apiman.manager.ui.client.local.events.MouseOutEvent.Handler)

addMouseInHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseInHandler(MouseInEvent.Handler handler)

Description copied from interface: MouseInEvent.HasMouseInHandlers

Adds an ok/cancel handler to the widget.

Specified by:

addMouseInHandler in interface MouseInEvent.HasMouseInHandlers

See Also:

MouseInEvent.HasMouseInHandlers.addMouseInHandler(io.apiman.manager.ui.client.local.events.MouseInEvent.Handler)