net.sf.mmm.client.ui.base.widget.custom.pattern

Class UiWidgetCustomMasterDetail<ROW>

java.lang.Object

net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation<VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidget<VALUE>

net.sf.mmm.client.ui.base.widget.custom.UiWidgetCustom<VALUE,DELEGATE>

net.sf.mmm.client.ui.base.widget.custom.UiWidgetCustomComposite<VALUE,UiWidgetRegular,UiWidgetDynamicPanel<UiWidgetRegular>>

net.sf.mmm.client.ui.base.widget.custom.pattern.AbstractUiWidgetCustomMasterDetail<List<ROW>,ROW,ROW>

net.sf.mmm.client.ui.base.widget.custom.pattern.UiWidgetCustomMasterDetail<ROW>

Type Parameters:

ROW - is the generic type of a single row out of the value.

All Implemented Interfaces:

AttributeReadAriaRole, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<List<ROW>>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteValueAdvanced<List<ROW>>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<List<ROW>>, UiFeatureValue<List<ROW>>, UiFeatureValueAndValidation<List<ROW>>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<List<ROW>>, UiWidgetComposite<UiWidgetRegular>, UiWidgetRegular, UiWidgetWithValue<List<ROW>>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<List<ROW>>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<List<ROW>>, Accessibility, AbstractValidatableObject, HasValueValidators<List<ROW>>, ValidatableObject<List<ROW>>

public class UiWidgetCustomMasterDetail<ROW>
extends AbstractUiWidgetCustomMasterDetail<List<ROW>,ROW,ROW>

This is the regular implementation of the custom master/detail widget.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

AbstractUiWidget.AccessHelper, AbstractUiWidget.EventSender, AbstractUiWidget.HandlerContainer

Field Summary

Fields

Modifier and Type	Field and Description
private UiWidgetCustom<ROW,?>	detailPanel
private UiWidgetListContainer<ROW>	masterPanel

Fields inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

STYLE_HEADER

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

HTML_ATTRIBUTE_ID, ID_SEPARATOR, PROPERTY_ID

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

Fields inherited from interface net.sf.mmm.util.lang.api.concern.Accessibility

WAI_ARIA

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UiWidgetCustomMasterDetail(UiContext context, UiWidgetDynamicPanel<UiWidgetRegular> delegate) The constructor.
	UiWidgetCustomMasterDetail(UiContext context, UiWidgetDynamicPanel<UiWidgetRegular> delegate, UiWidgetListContainer<ROW> masterPanel, UiWidgetCustom<ROW,?> detailPanel) The constructor.
	UiWidgetCustomMasterDetail(UiContext context, UiWidgetListContainer<ROW> masterPanel, UiWidgetCustom<ROW,?> detailPanel) The constructor.

Method Summary

Modifier and Type	Method and Description
protected UiWidgetCustom<ROW,?>	getDetailPanel() This method gets the details panel showing the detail for the current selection from the master list.
protected UiFeatureSelectedValue<ROW>	getMasterList() This method gets the actual widget containing a list of <SELECTION> to choose from.
protected UiWidgetListContainer<ROW>	getMasterPanel()
protected void	setDetailPanel(UiWidgetCustom<ROW,?> detailPanel) Sets the detail panel in case of lazy initialization.
protected void	setMasterPanel(UiWidgetListContainer<ROW> masterPanel) Sets the master panel in case of lazy initialization.

Methods inherited from class net.sf.mmm.client.ui.base.widget.custom.pattern.AbstractUiWidgetCustomMasterDetail

doGetValue, doInitialize, doSetMode, doSetValue, getDetailsForSelection, onMasterListSelection

Methods inherited from class net.sf.mmm.client.ui.base.widget.custom.UiWidgetCustomComposite

getChild, getChild, getChildCount, getChildIndex

Methods inherited from class net.sf.mmm.client.ui.base.widget.custom.UiWidgetCustom

addStyle, clearMessages, clearValidity, dispose, doValidate, getAriaRole, getDelegate, getDelegate, getId, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getSource, getStyles, getTooltip, getValueClass, getVisibleFlag, getWidgetAdapter, hasStyle, hasWidgetAdapter, initialize, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeFromParent, removeStyle, setEnabled, setFocused, setId, setMode, setMode, setModeFixed, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisible

Methods inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

addChangeHandler, addEventHandler, addValidator, clearMessagesLocal, clearValidationFailure, convertValueToString, fireEvent, fireValueChange, getBasicUtil, getContext, getDataBinding, getDataBinding, getDataBindingForWidget, getEventSender, getFactory, getLogger, getObserverSource, getOriginalValue, getRecentValue, getValueDirect, getValueOrException, getWidgetAdapter, hasEventSender, isMandatory, isModified, removeChangeHandler, removeEventHandler, removeFromParent, removeValidator, setMandatory, setModified, setParent, setValue, toString

Methods inherited from class net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation

addValidatorMandatory, createValidationFailure, getValue, getValueAndValidate, handleGetValueError, resetValue, setValue, setValueForUser, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

getContext, getParent, getSize

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureMessages

clearMessages

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureEvent

addEventHandler, removeEventHandler

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteMode

setMode

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadMode

getMode

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteModeFixed

setModeFixed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadModeFixed

getModeFixed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteHtmlId

setId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

getId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteTooltip

setTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadTooltip

getTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteVisibleAdvanced

getVisibleFlag, isVisible, setVisible, setVisible

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadVisibleRecursive

isVisibleRecursive

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteEnabled

setEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadEnabled

isEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStylesAdvanced

addStyle, removeStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStylesAdvanced

hasStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStyles

setStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

getStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWritePrimaryStyle

setPrimaryStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadPrimaryStyle

getPrimaryStyle

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteDisposed

dispose

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadDisposed

isDisposed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadModified

isModified

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAriaRole

getAriaRole

Methods inherited from interface net.sf.mmm.util.validation.api.AbstractValidatableObject

validate

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetWithValue

getValue

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValueAndValidation

getValueAndValidate, getValueDirect

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValue

addChangeHandler, removeChangeHandler

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteValueAdvanced

resetValue, setValue, setValue, setValueForUser

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadValueAdvanced

getOriginalValue, getValueOrException

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValidation

addValidatorMandatory, isMandatory

Methods inherited from interface net.sf.mmm.util.validation.api.HasValueValidators

addValidator, removeValidator

Field Detail

masterPanel

private UiWidgetListContainer<ROW> masterPanel

See Also:

getMasterPanel()

detailPanel

private UiWidgetCustom<ROW,?> detailPanel

See Also:

getDetailPanel()

Constructor Detail

UiWidgetCustomMasterDetail

protected UiWidgetCustomMasterDetail(UiContext context,
                                     UiWidgetDynamicPanel<UiWidgetRegular> delegate)

The constructor.

Parameters:

context - is the context.

delegate - is the delegate.

UiWidgetCustomMasterDetail

public UiWidgetCustomMasterDetail(UiContext context,
                                  UiWidgetDynamicPanel<UiWidgetRegular> delegate,
                                  UiWidgetListContainer<ROW> masterPanel,
                                  UiWidgetCustom<ROW,?> detailPanel)

The constructor.

Parameters:

context - is the context.

delegate - is the delegate.

masterPanel - - see getMasterPanel().

detailPanel - - see getDetailPanel().

UiWidgetCustomMasterDetail

public UiWidgetCustomMasterDetail(UiContext context,
                                  UiWidgetListContainer<ROW> masterPanel,
                                  UiWidgetCustom<ROW,?> detailPanel)

The constructor.

Parameters:

context - is the context.

masterPanel - - see getMasterPanel().

detailPanel - - see getDetailPanel().

Method Detail

getMasterPanel

protected UiWidgetListContainer<ROW> getMasterPanel()

Specified by:

getMasterPanel in class AbstractUiWidgetCustomMasterDetail<List<ROW>,ROW,ROW>

Returns:

the master panel containing the master list.

setMasterPanel

protected void setMasterPanel(UiWidgetListContainer<ROW> masterPanel)

Sets the master panel in case of lazy initialization.
ATTENTION:
This method has to be called only once and before super.AbstractUiWidgetCustomMasterDetail.doInitialize() has been invoked.

Parameters:

masterPanel - is the master panel to set.

getMasterList

protected UiFeatureSelectedValue<ROW> getMasterList()

This method gets the actual widget containing a list of <SELECTION> to choose from. This widget has to be a child of the master panel. A selection in the master list will automatically trigger an update of the details panel.
NOTE:
The details panel can only display a single <DETAIL> at a time. Therefore if multi-selection is enabled, nothing will be displayed in the details panel. This may still make sense to allow mass-operations such as remove in the master panel.

Specified by:

getMasterList in class AbstractUiWidgetCustomMasterDetail<List<ROW>,ROW,ROW>

Returns:

the master list.

getDetailPanel

protected UiWidgetCustom<ROW,?> getDetailPanel()

This method gets the details panel showing the detail for the current selection from the master list. If the <DETAIL> should be editable for the user, this details panel will typically be an editor.

Specified by:

getDetailPanel in class AbstractUiWidgetCustomMasterDetail<List<ROW>,ROW,ROW>

Returns:

the details panel.

setDetailPanel

protected void setDetailPanel(UiWidgetCustom<ROW,?> detailPanel)

Sets the detail panel in case of lazy initialization.
ATTENTION:
This method has to be called only once and before super.AbstractUiWidgetCustomMasterDetail.doInitialize() has been invoked.

Parameters:

detailPanel - is the detail panel to set.