com.github.bordertech.wcomponents.addons.table.edit

Class RowActionPanel<T>

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WBeanComponent

com.github.bordertech.wcomponents.WContainer

com.github.bordertech.wcomponents.addons.common.WDiv

com.github.bordertech.wcomponents.addons.table.edit.RowActionPanel<T>

Type Parameters:

T - the row bean type

All Implemented Interfaces:

RowActionable, com.github.bordertech.wcomponents.AjaxTarget, com.github.bordertech.wcomponents.BeanAware, com.github.bordertech.wcomponents.BeanBound, com.github.bordertech.wcomponents.BeanProviderBound, com.github.bordertech.wcomponents.Container, com.github.bordertech.wcomponents.DataBound, com.github.bordertech.wcomponents.MutableContainer, com.github.bordertech.wcomponents.NamingContextable, com.github.bordertech.wcomponents.SubordinateTarget, com.github.bordertech.wcomponents.WComponent, com.github.bordertech.wcomponents.WebComponent, Serializable

public class RowActionPanel<T>
extends WDiv
implements RowActionable

Table column renderer that allows row edit actions.

Since:

1.0.0

Author:

Jonathan Austin

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.addons.common.WDiv

WDiv.DivModel

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.AbstractWComponent.WComponentRef

Field Summary

Fields inherited from interface com.github.bordertech.wcomponents.WComponent

DEFAULT_APPLICATION_ID, DEFAULT_INTERNAL_ID, DEFAULT_NO_ID, ID_CONTEXT_SEPERATOR, ID_FRAMEWORK_ASSIGNED_SEPERATOR, ID_VALIDATION_PATTERN

Constructor Summary

Constructors

Constructor and Description
RowActionPanel() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRowModeKey(Object rowKey, RowMode mode)
void	clearRowModeKeys() Clear all the row mode keys.
protected List<com.github.bordertech.wcomponents.AjaxTarget>	getColumnAjaxTargets()
RowMode	getCurrentRowMode()
RowMode	getRowMode(Object rowKey)
RowMode	getRowModeKey(Object key)
protected com.github.bordertech.wcomponents.WTable	getTable()
protected void	handleCancelButtonAction() Handle the cancel button action.
protected void	handleDeleteButtonAction() Handle the delete button action.
protected void	handleEditButtonAction() Handle the edit button action.
protected boolean	isAllowEdit()
protected void	preparePaintComponent(com.github.bordertech.wcomponents.Request request)
void	removeRowModeKey(Object rowKey)
protected void	setupColumnAjaxTargets() Setup the row action AJAX targets (ie each column).

Methods inherited from class com.github.bordertech.wcomponents.addons.common.WDiv

afterPaint, beforePaint, getComponentModel, getOrCreateComponentModel, newComponentModel

Methods inherited from class com.github.bordertech.wcomponents.WContainer

add, add, getChildAt, getChildCount, getChildren, getIndexOfChild, getNamingContextId, isNamingContext, remove, removeAll, setNamingContext, setTemplate, setTemplate, setTemplateMarkUp

Methods inherited from class com.github.bordertech.wcomponents.WBeanComponent

addBeanToScratchMap, doUpdateBeanValue, getBean, getBeanFromScratchMap, getBeanId, getBeanProperty, getBeanProvider, getBeanScratchMap, getBeanValue, getData, isBeanInScratchMap, isChanged, isSearchAncestors, isUseRequestScopeScratchMap, removeBeanFromScratchMap, resetData, setBean, setBeanId, setBeanProperty, setBeanProvider, setData, setSearchAncestors, updateBeanValue

Methods inherited from class com.github.bordertech.wcomponents.AbstractWComponent

addHtmlClass, addHtmlClass, addNotify, assertAddSupported, createErrorDiagnostic, createErrorDiagnostic, forward, getAccessibleText, getAttribute, getBaseUrl, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, handleRequest, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, paintComponent, preparePaint, removeAttribute, removeComponentModel, removeHtmlClass, removeHtmlClass, removeNotify, replaceWComponent, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFlag, setFocussed, setHidden, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showErrorIndicatorsForComponent, showWarningIndicators, showWarningIndicatorsForComponent, tidyUpUIContext, tidyUpUIContextForTree, toString, validate, validateComponent, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.bordertech.wcomponents.WComponent

addHtmlClass, addHtmlClass, forward, getAccessibleText, getAttribute, getBaseUrl, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getTabIndex, getTag, getToolTip, handleRequest, hasTabIndex, invokeLater, isDefaultState, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, preparePaint, removeAttribute, removeHtmlClass, removeHtmlClass, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFocussed, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showWarningIndicators, tidyUpUIContextForTree, validate

Constructor Detail

RowActionPanel

public RowActionPanel()

Default constructor.

Method Detail

getCurrentRowMode

public RowMode getCurrentRowMode()

Specified by:

getCurrentRowMode in interface RowActionable

Returns:

the current row mode

getRowMode

public RowMode getRowMode(Object rowKey)

Specified by:

getRowMode in interface RowActionable

Parameters:

rowKey - the row key to check and considers if the table is editable

Returns:

the row mode

addRowModeKey

public void addRowModeKey(Object rowKey,
                 RowMode mode)

Specified by:

addRowModeKey in interface RowActionable

Parameters:

rowKey - add the following key to the row modes

mode - the row mode

removeRowModeKey

public void removeRowModeKey(Object rowKey)

Specified by:

removeRowModeKey in interface RowActionable

Parameters:

rowKey - remove the following key to the row modes

getRowModeKey

public RowMode getRowModeKey(Object key)

Specified by:

getRowModeKey in interface RowActionable

Parameters:

key - the row key to check

Returns:

the row mode

clearRowModeKeys

public void clearRowModeKeys()

Description copied from interface: RowActionable

Clear all the row mode keys.

Specified by:

clearRowModeKeys in interface RowActionable

preparePaintComponent

protected void preparePaintComponent(com.github.bordertech.wcomponents.Request request)

Overrides:

preparePaintComponent in class com.github.bordertech.wcomponents.AbstractWComponent

setupColumnAjaxTargets

protected void setupColumnAjaxTargets()

Setup the row action AJAX targets (ie each column).

handleEditButtonAction

protected void handleEditButtonAction()

Handle the edit button action.

handleDeleteButtonAction

protected void handleDeleteButtonAction()

Handle the delete button action.

handleCancelButtonAction

protected void handleCancelButtonAction()

Handle the cancel button action.

getColumnAjaxTargets

protected List<com.github.bordertech.wcomponents.AjaxTarget> getColumnAjaxTargets()

Returns:

the column AJAX targets

getTable

protected com.github.bordertech.wcomponents.WTable getTable()

Returns:

the parent table

isAllowEdit

protected boolean isAllowEdit()

Returns:

true if table is in edit mode