Package org.opencms.ui.components.editablegroup

Class CmsEditableGroupButtons

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

org.opencms.ui.components.editablegroup.CmsEditableGroupButtons

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.communication.ServerRpc, com.vaadin.shared.Connector, com.vaadin.ui.Component, Serializable, I_CmsEditableGroupButtonsServerRpc

public class CmsEditableGroupButtons
extends com.vaadin.ui.AbstractComponent
implements I_CmsEditableGroupButtonsServerRpc

Button bar for manipulating rows in a multivalued field list.

Has buttons for moving a row up and down, deleting it, and adding a new row.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor	Description
CmsEditableGroupButtons(I_CmsEditableGroupActionHandler actionHandler)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
CmsEditableGroupButtonsState	getState()
void	onAdd()	Called when user clicks on 'Add' button.
void	onDelete()	Called when user clicks on 'Delete' button.
void	onDown()	Called when user clicks on 'Down' button.
void	onEdit()	Called when user clicks on the 'Edit' button.
void	onUp()	Called when user clicks on 'Up' button.
void	setFirstLast(boolean first, boolean last, boolean hideAdd)	Sets the 'first' and 'last' status of the button bar.

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, readDesign, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined, writeDesign

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.ui.Component

addStyleNames, getUI, removeStyleNames, setStyleName

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Details

CmsEditableGroupButtons

public CmsEditableGroupButtons(I_CmsEditableGroupActionHandler actionHandler)

Creates a new instance.

Parameters:

actionHandler - handler which should be called for different button presses

Method Details

getState

public CmsEditableGroupButtonsState getState()

Overrides:

getState in class com.vaadin.ui.AbstractComponent

See Also:

• AbstractComponent.getState()

onAdd

public void onAdd()

Description copied from interface: I_CmsEditableGroupButtonsServerRpc

Called when user clicks on 'Add' button.

Specified by:

onAdd in interface I_CmsEditableGroupButtonsServerRpc

See Also:

• I_CmsEditableGroupButtonsServerRpc.onAdd()

onDelete

public void onDelete()

Description copied from interface: I_CmsEditableGroupButtonsServerRpc

Called when user clicks on 'Delete' button.

Specified by:

onDelete in interface I_CmsEditableGroupButtonsServerRpc

See Also:

• I_CmsEditableGroupButtonsServerRpc.onDelete()

onDown

public void onDown()

Description copied from interface: I_CmsEditableGroupButtonsServerRpc

Called when user clicks on 'Down' button.

Specified by:

onDown in interface I_CmsEditableGroupButtonsServerRpc

See Also:

• I_CmsEditableGroupButtonsServerRpc.onDown()

onEdit

public void onEdit()

Description copied from interface: I_CmsEditableGroupButtonsServerRpc

Called when user clicks on the 'Edit' button.

Specified by:

onEdit in interface I_CmsEditableGroupButtonsServerRpc

See Also:

• I_CmsEditableGroupButtonsServerRpc.onEdit()

onUp

public void onUp()

Description copied from interface: I_CmsEditableGroupButtonsServerRpc

Called when user clicks on 'Up' button.

Specified by:

onUp in interface I_CmsEditableGroupButtonsServerRpc

See Also:

• I_CmsEditableGroupButtonsServerRpc.onUp()

setFirstLast

public void setFirstLast(boolean first,
 boolean last,
 boolean hideAdd)

Sets the 'first' and 'last' status of the button bar.

Parameters:

first - true if this is the button bar of the first row

last - true if this is the button bar of the last row

hideAdd - true -> hide add option