Package com.vdoc.sdk.commons.ui.widget.view.inline.edit

Class CtlInlineEditButton<T extends IUpdatable<?>>

java.lang.Object

com.axemble.vdp.ui.framework.foundation.Component

com.axemble.vdp.ui.framework.foundation.Widget

com.axemble.vdp.ui.framework.widgets.CtlAbstractAction

com.axemble.vdp.ui.framework.widgets.CtlImageButton

com.vdoc.sdk.commons.ui.widget.view.inline.edit.CtlInlineEditButton<T>

Type Parameters:

T - the type

All Implemented Interfaces:

IAnyActionListener, IWidget, IWritable, com.axemble.vdp.ui.framework.components.listeners.ActionListener, INamedWidget, com.axemble.vdp.utils.parameters.ParamsHandler, Serializable

public class CtlInlineEditButton<T extends IUpdatable<?>>
extends com.axemble.vdp.ui.framework.widgets.CtlImageButton
implements com.axemble.vdp.ui.framework.components.listeners.ActionListener

Inline edit button graphical component

Author:

famaridon

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<IBeforeEditing>	beforeEditingList
protected final String	defaultCss
protected final String	editImage
protected InlineEditMode	inlineEditMode
protected final String	saveImage
protected List<String>	scriptOnAfterValidateList
protected T	updatable
protected List<UpdateableListener<T>>	updateableListenerList
protected final com.axemble.vdp.ui.framework.composites.base.CtlAbstractView	view
protected final String	viewItemDefaultCss
protected final com.axemble.vdp.ui.framework.composites.base.models.views.ViewModelItem	viewModelItem

Fields inherited from class com.axemble.vdp.ui.framework.widgets.CtlImageButton

cssImageClass, customRenderer, enabled, imageUrl, onclick, rel, target, title, url

Fields inherited from class com.axemble.vdp.ui.framework.widgets.CtlAbstractAction

customWidgets, label, name

Fields inherited from class com.axemble.vdp.ui.framework.foundation.Widget

actionListeners, isHidden, param, parentBlock, sysname, userId

Fields inherited from class com.axemble.vdp.ui.framework.foundation.Component

changeListeners, LOGGER

Fields inherited from interface com.axemble.vdp.utils.parameters.ParamsHandler

ERROR_EXCEED_ELEM_SIZE, ERROR_EXCEED_TOTAL_SIZE, ERROR_NOT_COMPLETED, ERROR_READ_FAILED, EXCEED_ELEM_NUMBER, NO_ERROR

Constructor Summary

Constructors

Constructor	Description
CtlInlineEditButton(String actionName, String editImage, String saveImage, T updatable, com.axemble.vdp.ui.framework.composites.base.models.views.ViewModelItem viewModelItem, com.axemble.vdp.ui.framework.composites.base.CtlAbstractView view, String defaultCss)	Constructor
CtlInlineEditButton(String actionName, String editImage, T updatable, com.axemble.vdp.ui.framework.composites.base.models.views.ViewModelItem viewModelItem, com.axemble.vdp.ui.framework.composites.base.CtlAbstractView view, String defaultCss)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addBeforeEditing(IBeforeEditing beforeEditing)	Add before editing
void	addScriptOnAfterValidate(String script)	Add script on after validate
boolean	addUpdateableListener(UpdateableListener<T> updatableListener)	Add updatable listener
void	cancel()	cancel edit mode, return to read value
InlineEditMode	getInlineEditMode()	get inlineEditMode property
void	onClick(com.axemble.vdp.ui.framework.components.events.ActionEvent actionevent)
IWritable	render()	Render the widget
void	setInlineEditMode(InlineEditMode inlineEditMode)	set inlineEditMode property
void	switchTo(InlineEditMode inlineEditMode)	Switch mode
protected <V> void	updateValues()

Methods inherited from class com.axemble.vdp.ui.framework.widgets.CtlImageButton

getCssImageClass, getImageByActionName, getImageTitleByActionName, getImageUrl, getOnclick, getRel, getTarget, getTitle, getUrl, handleAction, isEnabled, setCssImageClass, setCustomRenderer, setEnabled, setImage, setImageUrl, setOnclick, setRel, setTarget, setTitle, setUrl

Methods inherited from class com.axemble.vdp.ui.framework.widgets.CtlAbstractAction

addCustomWidget, fireActionEvent, getCustomWidgets, getLabel, getName, setLabel

Methods inherited from class com.axemble.vdp.ui.framework.foundation.Widget

addActionListener, afterInit, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireOnClickMessage, buildFireOnClickMessage, buildFormName, findFileRecipient, findStringRecipient, findXmlRecipient, focus, getCtrlTemplate, getCtrlTemplateWriter, getJavaScriptFocusScript, getJavascriptId, getParam, getParentBlock, getSysname, getUserDisplayName, getUserId, handleParams, hasActionListeners, isHidden, refresh, refreshWidgets, removeActionListener, removeActionListeners, renderMobile, setHidden, setParam, setParentBlock, setSysname, setUserId, write

Methods inherited from class com.axemble.vdp.ui.framework.foundation.Component

addChangeListener, createComponent, evaluateExpressions, fireChangeEvent, getDynamicDescription, getDynamicLabel, getLanguage, getNavigator, getRootNavigator, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, hasChangeListeners, removeChangeListener, removeChangeListeners, stateChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.IWidget

addActionListener, addChangeListener, afterInit, getCtrlTemplate, getCtrlTemplateWriter, getParam, getParentBlock, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysname, hasActionListeners, hasChangeListeners, isHidden, refresh, refreshWidgets, removeActionListener, removeActionListeners, removeChangeListener, removeChangeListeners, renderMobile, setHidden, setParentBlock, setSysname

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.IWritable

write

Field Details

viewModelItem

protected final com.axemble.vdp.ui.framework.composites.base.models.views.ViewModelItem viewModelItem

view

protected final com.axemble.vdp.ui.framework.composites.base.CtlAbstractView view

inlineEditMode

protected InlineEditMode inlineEditMode

defaultCss

protected final String defaultCss

editImage

protected final String editImage

saveImage

protected final String saveImage

viewItemDefaultCss

protected final String viewItemDefaultCss

scriptOnAfterValidateList

protected List<String> scriptOnAfterValidateList

beforeEditingList

protected List<IBeforeEditing> beforeEditingList

updateableListenerList

protected List<UpdateableListener<T extends IUpdatable<?>>> updateableListenerList

updatable

protected T extends IUpdatable<?> updatable

Constructor Details

CtlInlineEditButton

public CtlInlineEditButton(String actionName,
 String editImage,
 T updatable,
 com.axemble.vdp.ui.framework.composites.base.models.views.ViewModelItem viewModelItem,
 com.axemble.vdp.ui.framework.composites.base.CtlAbstractView view,
 String defaultCss)

Constructor

Parameters:

actionName - the action name

editImage - the edit image

updatable - the updatable

viewModelItem - the view model item

view - the view

defaultCss - the default Css

CtlInlineEditButton

public CtlInlineEditButton(String actionName,
 String editImage,
 String saveImage,
 T updatable,
 com.axemble.vdp.ui.framework.composites.base.models.views.ViewModelItem viewModelItem,
 com.axemble.vdp.ui.framework.composites.base.CtlAbstractView view,
 String defaultCss)

Constructor

Parameters:

actionName - the action name

editImage - the edit image

saveImage - the save image

updatable - the updatable

viewModelItem - the view model item

view - the view

defaultCss - the default Css

Method Details

setInlineEditMode

public void setInlineEditMode(InlineEditMode inlineEditMode)

set inlineEditMode property

Parameters:

inlineEditMode - set the inlineEditMode property

render

public IWritable render()
                 throws RenderException

Description copied from interface: IWidget

Render the widget

Specified by:

render in interface IWidget

Overrides:

render in class com.axemble.vdp.ui.framework.widgets.CtlImageButton

Returns:

writableWidget

Throws:

RenderException

getInlineEditMode

public InlineEditMode getInlineEditMode()

get inlineEditMode property

Returns:

get the inlineEditMode property

switchTo

public void switchTo(InlineEditMode inlineEditMode)

Switch mode

Parameters:

inlineEditMode - the inline edit mode to switch to (read or write)

onClick

public void onClick(com.axemble.vdp.ui.framework.components.events.ActionEvent actionevent)

Specified by:

onClick in interface com.axemble.vdp.ui.framework.components.listeners.ActionListener

cancel

public void cancel()

cancel edit mode, return to read value

updateValues

protected <V> void updateValues()
                         throws ValidationException

Throws:

ValidationException

addUpdateableListener

public boolean addUpdateableListener(UpdateableListener<T> updatableListener)

Add updatable listener

Parameters:

updatableListener - the listener

Returns:

true

addScriptOnAfterValidate

public void addScriptOnAfterValidate(String script)

Add script on after validate

Parameters:

script - the script

addBeforeEditing

public void addBeforeEditing(IBeforeEditing beforeEditing)

Add before editing

Parameters:

beforeEditing - the before editing action