- Direct Known Subclasses:
public abstract class WAbstractItemDelegate extends WObject
Rendering of an item in a
WAbstractItemView is delegated to an implementation of this
delegate class. The default implementation used by JWt's item views is
WItemDelegate. To provide specialized rendering support, you can reimplement this class (or
As a delegate is used for rendering multiple items, the class should not keep state about one specific item.
A delegate may provide editing support by instantiating an editor when
called with the
ViewItemRenderFlag.RenderEditing flag. In that case, you will also need
setEditState() to support
virtual scrolling and
setModelData() to save the edited value to the
model. For an example, see the
Nested Class Summary
Constructors Constructor Description
Modifier and Type Method Description
()Signal which indicates that an editor needs to be closed.
WWidget widget)(Returns the current edit state.
WWidget widget, java.lang.Object value)(Sets the editor data from the editor state.
WAbstractItemModel model, WModelIndex index)(java.lang.Object editState,Saves the edited data to the model.
WWidget widget, WModelIndex index, ViewItemRenderFlag flag, ViewItemRenderFlag... flags)(Creates or updates a widget that renders an item.
WWidget widget, WModelIndex index, java.util.EnumSet<ViewItemRenderFlag> flags)(Creates or updates a widget that renders an item.
WWidget widget, WModelIndex index)(Updates the model index of a widget.
WModelIndex index, java.lang.Object editState)(Returns whether the edited value is valid.
Methods inherited from class eu.webtoolkit.jwt.WObject
addChild, getId, getObjectName, remove, setFormData, setObjectName, tr
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
updatepublic abstract WWidget update(WWidget widget, WModelIndex index, java.util.EnumSet<ViewItemRenderFlag> flags)Creates or updates a widget that renders an item.
The item is specified by its model
index, which also indicates the model. If an existing widget already renders the item, but needs to be updated, it is passed as the
widgetparameter. You may decide to create a new widget, in which case you are responsible to delete the previous
widgetif it is not reused.
null, a new widget needs to be created.
The returned widget should be a widget that responds properly to be given a height, width and style class. In practice, that means it cannot have a border or margin, and thus cannot be a
WFormWidgetsince those widgets typically have built-in borders and margins. If you want to return a form widget (for editing the item), you should wrap it in a container widget.
flagsparameter indicates options for rendering the item.
updatepublic final WWidget update(WWidget widget, WModelIndex index, ViewItemRenderFlag flag, ViewItemRenderFlag... flags)Creates or updates a widget that renders an item.
updateModelIndexUpdates the model index of a widget.
This method is invoked by the view when due to row/column insertions or removals, the index has shifted.
You should reimplement this method only if you are storing the model index in the
widget, to update the stored model index.
The default implementation does nothing.
getEditStatepublic java.lang.Object getEditState(WWidget widget)Returns the current edit state.
Because a View may support virtual scrolling in combination with editing, it may happen that the view decides to delete the editor widget while the user is editing. To allow to reconstruct the editor in its original state, the View will therefore ask for the editor to serialize its state in a boost::any.
The default implementation assumes a read-only delegate, and returns a boost::any().
setEditStatepublic void setEditState(WWidget widget, java.lang.Object value)Sets the editor data from the editor state.
When the View scrolls back into view an item that was being edited, he will use
setEditState()to allow the editor to restore its current editor state.
The default implementation assumes a read-only delegate and does nothing.
- See Also:
validateReturns whether the edited value is valid.
The default implementation does nothing and returns Valid.
- See Also:
setModelDataSaves the edited data to the model.
The View will use this method to save the edited value to the model. The
editStateis first fetched from the editor using
The default implementation assumes a read-only delegate does nothing.
closeEditorSignal which indicates that an editor needs to be closed.
The delegate should emit this signal when it decides for itself that it should be closed (e.g. because the user confirmed the edited value or cancelled the editing). The View will then rerender the item if needed.
The second boolean argument passed to the signal is a flag which indicates whether the editor feels that the value should be saved or cancelled.