Class WAbstractItemView
- Direct Known Subclasses:
WTableView
,WTreeView
public abstract class WAbstractItemView extends WCompositeWidget
See WTableView
or WTreeView
for a description.
i18n
The strings used in this class can be translated by overriding the default values for the following localization keys:
- Wt.WAbstractItemView.PageIOfN: {1} of {2}
- Wt.WAbstractItemView.PageBar.First: 슫 First
- Wt.WAbstractItemView.PageBar.Previous: � Previous
- Wt.WAbstractItemView.PageBar.Next: Next �
- Wt.WAbstractItemView.PageBar.Last: Last 슻
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WAbstractItemView.EditOption
Enumeration that specifies editing options.static class
WAbstractItemView.EditTrigger
Enumeration that specifies the user action that triggers editing.static class
WAbstractItemView.ScrollHint
Enumeration that specifies a scrolling option.Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject
WObject.FormData
-
Constructor Summary
Constructors Modifier Constructor Description protected
WAbstractItemView()
Creates a new item view.protected
WAbstractItemView(WContainerWidget parent)
Creates a new item view. -
Method Summary
Modifier and Type Method Description void
clearSelection()
Clears the selection.Signal2<WModelIndex,WMouseEvent>
clicked()
Signal emitted when clicked.void
closeEditor(WModelIndex index)
Closes the editor for the given index.void
closeEditor(WModelIndex index, boolean saveData)
Closes the editor for the given index.void
closeEditors()
Closes all open editors.void
closeEditors(boolean saveData)
Closes all open editors.Signal2<java.lang.Integer,WLength>
columnResized()
Returns the signal emitted when a column is resized by the user.protected WWidget
createExtraHeaderWidget(int column)
Create an extra widget in the header.protected WWidget
createHeaderWidget(int column)
Signal2<WModelIndex,WMouseEvent>
doubleClicked()
Signal emitted when double clicked.protected void
dropEvent(WDropEvent e, WModelIndex index)
Handles a drop event (drag & drop).void
edit(WModelIndex index)
Opens an editor for the given index.protected WWidget
extraHeaderWidget(int column)
Returns the extra header widget.AlignmentFlag
getColumnAlignment(int column)
Returns the content alignment for a column.WLength
getColumnWidth(int column)
Returns the column width.protected WWidget
getCreatePageNavigationBar()
Returns a page navigation widget.abstract int
getCurrentPage()
Returns the current page.java.util.EnumSet<WAbstractItemView.EditOption>
getEditOptions()
Returns the editing options.java.util.EnumSet<WAbstractItemView.EditTrigger>
getEditTriggers()
Returns the editing triggers.AlignmentFlag
getHeaderAlignment(int column)
Deprecated.WLength
getHeaderHeight()
Returns the header height.WAbstractItemDelegate
getHeaderItemDelegate()
Returns the header item delegate.WAbstractItemDelegate
getItemDelegate()
Returns the default item delegate.WAbstractItemDelegate
getItemDelegate(int column)
Returns the delegate for a column.WAbstractItemDelegate
getItemDelegate(WModelIndex index)
Returns the delegate for rendering an item.WAbstractItemDelegate
getItemDelegateForColumn(int column)
Returns the delegate that was set for a column.WAbstractItemModel
getModel()
Returns the model.abstract int
getPageCount()
Returns the number of pages.abstract int
getPageSize()
Returns the page size.WModelIndex
getRootIndex()
Returns the root index.int
getRowHeaderCount()
Returns the number of columns that are used as row headers.WLength
getRowHeight()
Returns the row height.java.util.SortedSet<WModelIndex>
getSelectedIndexes()
Returns the set of selected items.SelectionBehavior
getSelectionBehavior()
Returns the selection behaviour.SelectionMode
getSelectionMode()
Returns the selection mode.WItemSelectionModel
getSelectionModel()
Returns the selection model.int
getSortColumn()
Returns the current sorting columm.SortOrder
getSortOrder()
Returns the current sorting order.protected void
handleTouchEnd(java.util.List<WModelIndex> indices, WTouchEvent event)
Handles a touch ended event.protected void
handleTouchMove(java.util.List<WModelIndex> indices, WTouchEvent event)
Handles a touch moved event.protected void
handleTouchSelect(java.util.List<WModelIndex> indices, WTouchEvent event)
Handles a touch select event.protected void
handleTouchStart(java.util.List<WModelIndex> indices, WTouchEvent event)
Handles a touch started event.boolean
hasAlternatingRowColors()
Returns whether alternating row colors are used.Signal2<java.lang.Integer,WMouseEvent>
headerClicked()
Signal emitted when a header item is clicked.Signal2<java.lang.Integer,WMouseEvent>
headerDoubleClicked()
Signal emitted when a header item is double clicked.Signal2<java.lang.Integer,WMouseEvent>
headerMouseWentDown()
Signal emitted when a mouse button is pressed on a header itemSignal2<java.lang.Integer,WMouseEvent>
headerMouseWentUp()
Signal emitted when a mouse button is released on a header itemvoid
hideColumn(int column)
Hides a column.AlignmentFlag
horizontalHeaderAlignment(int column)
Returns the horizontal header alignment for a column.boolean
isColumn1Fixed()
Deprecated.UsegetRowHeaderCount()
instead.boolean
isColumnHidden(int column)
Returns if a column is hidden.boolean
isColumnResizeEnabled()
Returns whether column resizing is enabled.boolean
isEditing(WModelIndex index)
Returns whether an editor is open for a given index.boolean
isSelected(WModelIndex index)
Returns wheter an item is selected.boolean
isSortEnabled()
Returns whether the view is sortable.boolean
isSortingEnabled()
Returns whether sorting is enabled.boolean
isSortingEnabled(int column)
Returns whether sorting is enabled for a single column.boolean
isValid(WModelIndex index)
Returns whether an editor's state is valid.abstract WWidget
itemWidget(WModelIndex index)
Returns the widget that renders an item.EventSignal1<WKeyEvent>
keyPressed()
Event signal emitted when a "character" was entered.EventSignal1<WKeyEvent>
keyWentDown()
Event signal emitted when a keyboard key is pushed down.EventSignal1<WKeyEvent>
keyWentUp()
Event signal emitted when a keyboard key is released.protected void
modelHeaderDataChanged(Orientation orientation, int start, int end)
Signal2<WModelIndex,WMouseEvent>
mouseWentDown()
Signal emitted when a mouse button is pressed down.Signal2<WModelIndex,WMouseEvent>
mouseWentUp()
Signal emitted when the mouse button is released.Signal
pageChanged()
Signal emitted when page information was updated.void
remove()
Destructor.abstract EventSignal1<WScrollEvent>
scrolled()
Signal emitted when scrolling.void
scrollTo(WModelIndex index)
Scrolls the view to an item.abstract void
scrollTo(WModelIndex index, WAbstractItemView.ScrollHint hint)
Scrolls the view to an item.void
select(WModelIndex index)
Selects a single item.void
select(WModelIndex index, SelectionFlag option)
Selects a single item.Signal
selectionChanged()
Signal emitted when the selection is changed.void
setAlternatingRowColors(boolean enable)
Sets if alternating row colors are to be used.void
setColumn1Fixed(boolean enable)
Deprecated.UsesetRowHeaderCount()
instead.void
setColumnAlignment(int column, AlignmentFlag alignment)
Sets the content alignment for a column.void
setColumnBorder(WColor anon1)
Deprecated.void
setColumnHidden(int column, boolean hidden)
Changes the visibility of a column.void
setColumnResizeEnabled(boolean enabled)
Enables interactive column resizing.abstract void
setColumnWidth(int column, WLength width)
Sets the column width.abstract void
setCurrentPage(int page)
Sets the current page.void
setDragEnabled(boolean enable)
Enables the selection to be dragged (drag & drop).void
setDropsEnabled(boolean enable)
Enables drop operations (drag & drop).void
setEditOptions(WAbstractItemView.EditOption editOption, WAbstractItemView.EditOption... editOptions)
Configures editing options.void
setEditOptions(java.util.EnumSet<WAbstractItemView.EditOption> editOptions)
Configures editing options.void
setEditTriggers(WAbstractItemView.EditTrigger editTrigger, WAbstractItemView.EditTrigger... editTriggers)
Configures what actions should trigger editing.void
setEditTriggers(java.util.EnumSet<WAbstractItemView.EditTrigger> editTriggers)
Configures what actions should trigger editing.void
setHeaderAlignment(int column, AlignmentFlag alignmen, AlignmentFlag... alignment)
Sets the header alignment for a column.void
setHeaderAlignment(int column, java.util.EnumSet<AlignmentFlag> alignment)
Sets the header alignment for a column.void
setHeaderClickSortEnabled(boolean enabled)
Alow to sort.void
setHeaderHeight(WLength height)
Sets the header height.void
setHeaderHeight(WLength height, boolean multiLine)
Deprecated.void
setHeaderItemDelegate(WAbstractItemDelegate delegate)
Sets the header item delegate.void
setHeaderWordWrap(int column, boolean enabled)
Configures header text wrapping.void
setItemDelegate(WAbstractItemDelegate delegate)
Sets the default item delegate.void
setItemDelegateForColumn(int column, WAbstractItemDelegate delegate)
Sets the delegate for a column.void
setModel(WAbstractItemModel model)
Sets the model.void
setObjectName(java.lang.String name)
Sets an object name.void
setRootIndex(WModelIndex rootIndex)
Sets the root index.void
setRowHeaderCount(int count)
Configures the number of columns that are used as row headers.void
setRowHeight(WLength rowHeight)
Sets the row height.void
setSelectedIndexes(java.util.SortedSet<WModelIndex> indexes)
Sets the selected items.void
setSelectionBehavior(SelectionBehavior behavior)
Changes the selection behaviour.void
setSelectionMode(SelectionMode mode)
Sets the selection mode.void
setSortingEnabled(boolean enabled)
Enables or disables sorting for all columns.void
setSortingEnabled(int column, boolean enabled)
Enables or disables sorting for a single column.protected boolean
shiftEditorColumns(WModelIndex parent, int start, int count, boolean persistWhenShifted)
protected boolean
shiftEditorRows(WModelIndex parent, int start, int count, boolean persistWhenShifted)
void
showColumn(int column)
Shows a column.void
sortByColumn(int column, SortOrder order)
Sorts the data according to a column.Signal2<java.util.List<WModelIndex>,WTouchEvent>
touchEnded()
Signal emitted when one or more fingers are removed from the screen.Signal2<java.util.List<WModelIndex>,WTouchEvent>
touchMoved()
Signal emitted when one or more fingers are moved on the screen.Signal2<WModelIndex,WTouchEvent>
touchStart()
Deprecated.UsetouchStarted()
instead.Signal2<java.util.List<WModelIndex>,WTouchEvent>
touchStarted()
Signal emitted when one or more fingers are placed on the screen.WValidator.State
validateEditor(WModelIndex index)
Validates the editor for the given index.WValidator.State
validateEditors()
Validates all editors.AlignmentFlag
verticalHeaderAlignment(int column)
Returns the vertical header alignment for a column.Methods inherited from class eu.webtoolkit.jwt.WCompositeWidget
addStyleClass, boxBorder, boxPadding, callJavaScriptMember, doJavaScript, enableAjax, find, findById, getAttributeValue, getBaseZIndex, getClearSides, getDecorationStyle, getFloatSide, getHeight, getId, getImplementation, getJavaScriptMember, getLineHeight, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getObjectName, getOffset, getPositionScheme, getScrollVisibilityMargin, getStyleClass, getTabIndex, getTakeImplementation, getToolTip, getVerticalAlignment, getVerticalAlignmentLength, getWidth, hasFocus, hasStyleClass, isCanReceiveFocus, isDisabled, isEnabled, isHidden, isHiddenKeepsGeometry, isInline, isLoaded, isPopup, isScrollVisibilityEnabled, isScrollVisible, isSetFirstFocus, isThemeStyleEnabled, isVisible, load, propagateSetEnabled, propagateSetVisible, refresh, removeStyleClass, render, resize, scrollVisibilityChanged, setAttributeValue, setCanReceiveFocus, setClearSides, setDecorationStyle, setDeferredToolTip, setDisabled, setFloatSide, setFocus, setHidden, setHiddenKeepsGeometry, setId, setImplementation, setInline, setJavaScriptMember, setLineHeight, setMargin, setMaximumSize, setMinimumSize, setOffsets, setPopup, setPositionScheme, setScrollVisibilityEnabled, setScrollVisibilityMargin, setSelectable, setStyleClass, setTabIndex, setThemeStyleEnabled, setToolTip, setVerticalAlignment
Methods inherited from class eu.webtoolkit.jwt.WWidget
acceptDrops, acceptDrops, addCssRule, addCssRule, addJSignal, addStyleClass, animateHide, animateShow, createJavaScript, disable, dropEvent, enable, getDropTouch, getJsRef, getParent, hide, htmlText, isExposed, isLayoutSizeAware, isRendered, layoutSizeChanged, needsRerender, positionAt, positionAt, removeChild, removeStyleClass, render, resize, scheduleRender, scheduleRender, scheduleRender, setClearSides, setDeferredToolTip, setFocus, setHeight, setHidden, setLayoutSizeAware, setMargin, setMargin, setMargin, setMargin, setMargin, setOffsets, setOffsets, setOffsets, setOffsets, setOffsets, setToolTip, setVerticalAlignment, setWidth, show, stopAcceptDrops, toggleStyleClass, toggleStyleClass, tr
Methods inherited from class eu.webtoolkit.jwt.WObject
addChild, setFormData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
WAbstractItemView
Creates a new item view. -
WAbstractItemView
protected WAbstractItemView()Creates a new item view.
-
-
Method Details
-
remove
public void remove()Description copied from class:WWidget
Destructor.Deletes a widget and all children (recursively). If the widget is contained in another widget, it is removed first.
- Overrides:
remove
in classWCompositeWidget
- See Also:
WContainerWidget.removeWidget(WWidget widget)
-
setModel
Sets the model.The View will display data of the given
model
and changes in the model are reflected by the View.The initial model is
null
.- See Also:
setRootIndex(WModelIndex rootIndex)
-
getModel
Returns the model.- See Also:
setModel(WAbstractItemModel model)
-
setRootIndex
Sets the root index.The root index is the model index that is considered the root node. This node itself is not rendered, but its children are.
The default value is
null
, corresponding to the model's root node.- See Also:
setModel(WAbstractItemModel model)
-
getRootIndex
Returns the root index.- See Also:
setRootIndex(WModelIndex rootIndex)
-
setItemDelegate
Sets the default item delegate.The previous delegate is not deleted. This item delegate is for all columns for which no specific item delegate is set.
The default item delegate is a
WItemDelegate
. -
getItemDelegate
Returns the default item delegate. -
setItemDelegateForColumn
Sets the delegate for a column.A delegate previously set (if any) is not deleted.
-
getItemDelegateForColumn
Returns the delegate that was set for a column.Returns
null
if no delegate was set for the column. -
getItemDelegate
Returns the delegate for rendering an item. -
getItemDelegate
Returns the delegate for a column.Returns either the delegate that was set for the column, or the default delegate.
-
itemWidget
Returns the widget that renders an item.This returns the widget that renders the given item. This may return 0 if the item is currently not rendered.
This widget has been created by an item delegate, and usually an item delegate is involved when updating it.
-
setHeaderItemDelegate
Sets the header item delegate.This item delegate is used for rendering items in the header.
The previous delegate is not deleted. This item delegate is for all columns for which no specific item delegate is set.
The default item delegate is a
WItemDelegate
. -
getHeaderItemDelegate
Returns the header item delegate. -
setColumnAlignment
Sets the content alignment for a column.The default value is
AlignmentFlag.AlignLeft
. -
getColumnAlignment
Returns the content alignment for a column. -
setHeaderAlignment
Sets the header alignment for a column.The default alignemnt is horizontally left, and vertically centered. (
AlignmentFlag.AlignLeft
|AlignmentFlag.AlignMiddle
).Valid options for horizontal alignment are
AlignmentFlag.AlignLeft
,AlignmentFlag.AlignCenter
orAlignmentFlag.AlignRight
.Valid options for vertical alignment are
AlignmentFlag.AlignMiddle
orAlignmentFlag.AlignTop
. In the latter case, other contents may be added below the label increateExtraHeaderWidget()
. -
setHeaderAlignment
public final void setHeaderAlignment(int column, AlignmentFlag alignmen, AlignmentFlag... alignment)Sets the header alignment for a column.Calls
setHeaderAlignment(column, EnumSet.of(alignmen, alignment))
-
getHeaderAlignment
Deprecated.usehorizontalHeaderAlignment()
instead.Returns the horizontal header alignment for a column (deprecated). -
horizontalHeaderAlignment
Returns the horizontal header alignment for a column. -
verticalHeaderAlignment
Returns the vertical header alignment for a column. -
setHeaderWordWrap
public void setHeaderWordWrap(int column, boolean enabled)Configures header text wrapping.This setting only affects a multiline header, and the default value is
true
. When set tofalse
, the header itself will not wrap (as with a vertically centered header), and thus extra widgets will not shift down when there is a long header label. -
setAlternatingRowColors
public void setAlternatingRowColors(boolean enable)Sets if alternating row colors are to be used.Configure whether rows get alternating background colors, defined by the current CSS theme.
The default value is
false
. -
hasAlternatingRowColors
public boolean hasAlternatingRowColors()Returns whether alternating row colors are used.When enabled, rows are displayed in alternating row colors, according to the current theme's definition.
- See Also:
setAlternatingRowColors(boolean enable)
-
sortByColumn
Sorts the data according to a column.Sorts the data according to data in column
column
and sort orderorder
.The default sorting column is -1: the model is unsorted.
-
getSortColumn
public int getSortColumn()Returns the current sorting columm. -
getSortOrder
Returns the current sorting order. -
setSortingEnabled
public void setSortingEnabled(boolean enabled)Enables or disables sorting for all columns.Enable or disable sorting by the user on all columns.
Sorting is enabled by default.
-
setSortingEnabled
public void setSortingEnabled(int column, boolean enabled)Enables or disables sorting for a single column.Enable or disable sorting by the user for a specific column.
Sorting is enabled by default.
-
isSortingEnabled
public boolean isSortingEnabled()Returns whether sorting is enabled.- See Also:
setSortingEnabled(boolean enabled)
-
isSortingEnabled
public boolean isSortingEnabled(int column)Returns whether sorting is enabled for a single column.- See Also:
setSortingEnabled(boolean enabled)
-
setColumnResizeEnabled
public void setColumnResizeEnabled(boolean enabled)Enables interactive column resizing.Enable or disable column resize handles for interactive resizing of the columns.
Column resizing is enabled by default when JavaScript is available.
- See Also:
setColumnResizeEnabled(boolean enabled)
-
isColumnResizeEnabled
public boolean isColumnResizeEnabled()Returns whether column resizing is enabled.- See Also:
setColumnResizeEnabled(boolean enabled)
-
setSelectionBehavior
Changes the selection behaviour.The selection behavior indicates whether whole rows or individual items can be selected. It is a property of the
getSelectionModel()
.By default, selection operates on rows (
SelectionBehavior.SelectRows
), in which case model indexes will always be in the first column (columnnull
).Alternatively, you can allow selection for individual items (
SelectionBehavior.SelectItems
). -
getSelectionBehavior
Returns the selection behaviour. -
setSelectionMode
Sets the selection mode.By default selection is disabled (
SelectionMode.NoSelection
). -
getSelectionMode
Returns the selection mode.- See Also:
setSelectionMode(SelectionMode mode)
-
getSelectionModel
Returns the selection model.The selection model keeps track of the currently selected items.
-
setSelectedIndexes
Sets the selected items.Replaces the current selection with
indexes
.When selection operates on rows (
SelectionBehavior.SelectRows
), it is sufficient to pass the first element in a row (columnnull
) to select the entire row. -
clearSelection
public void clearSelection()Clears the selection.- See Also:
setSelectedIndexes(SortedSet indexes)
-
select
Selects a single item. -
select
Selects a single item. -
isSelected
Returns wheter an item is selected.When selection operates on rows (
SelectionBehavior.SelectRows
), this method returns true for each element in a selected row.This is a convenience method for:
selectionModel().isSelected(index)
-
getSelectedIndexes
Returns the set of selected items.The model indexes are returned as a set, topologically ordered (in the order they appear in the view).
When selection operates on rows (
SelectionBehavior.SelectRows
), this method only returns the model index of first column's element of the selected rows.This is a convenience method for:
selectionModel().selectedIndexes()
- See Also:
setSelectedIndexes(SortedSet indexes)
-
setDragEnabled
public void setDragEnabled(boolean enable)Enables the selection to be dragged (drag & drop).To enable dragging of the selection, you first need to enable selection using
setSelectionMode()
.Whether an individual item may be dragged is controlled by the item's
ItemFlag.ItemIsDragEnabled
flag. The selection can be dragged only if all items currently selected can be dragged.- See Also:
setDropsEnabled(boolean enable)
-
setDropsEnabled
public void setDropsEnabled(boolean enable)Enables drop operations (drag & drop).When drop is enabled, the tree view will indicate that something may be dropped when the mime-type of the dragged object is compatible with one of the model's accepted drop mime-types (see
WAbstractItemModel.getAcceptDropMimeTypes()
) or this widget's accepted drop mime-types (seeWWidget#acceptDrops()
), and the target item has drop enabled (which is controlled by the item'sItemFlag.ItemIsDropEnabled
flag).Drop events must be handled in
dropEvent()
. -
setRowHeight
Sets the row height.The view renders all rows with a same height. This method configures this row height.
The default value is 20 pixels.
Note: The height must be specified in
Unit#Pixel
units. -
getRowHeight
Returns the row height. -
setColumnWidth
Sets the column width.The default column width is 150 pixels.
Note: The width must be specified in
Unit#Pixel
units.Note: The actual space occupied by each column is the column width augmented by 7 pixels for internal padding and a border.
-
getColumnWidth
Returns the column width. -
setColumnHidden
public void setColumnHidden(int column, boolean hidden)Changes the visibility of a column.- See Also:
isColumnHidden(int column)
-
isColumnHidden
public boolean isColumnHidden(int column)Returns if a column is hidden. -
hideColumn
public void hideColumn(int column)Hides a column. -
showColumn
public void showColumn(int column)Shows a column. -
setColumnBorder
Deprecated.Sets the column border color (deprecated)This method has no effect. The border color should be set using CSS.
-
setHeaderHeight
Sets the header height.The default value is 20 pixels.
Note: The height must be specified in
Unit#Pixel
units. -
setHeaderHeight
Deprecated.Sets the header height, and vertical alignment (deprecated). By default, the header text is a single line that is centered vertically.Along with setting the header height, this also configures vertical aligment and header label word wrapping. This has been deprecated in favour of the more fine grained control using
setHeaderAlignment()
andsetHeaderWordWrap()
.When
multiLine
isfalse
, the header alignment is set toAlignmentFlag.AlignMiddle
. WhenmultiLine
istrue
, the header alignment is set toAlignmentFlag.AlignTop
and header word wrap is set totrue
. -
getHeaderHeight
Returns the header height.- See Also:
setHeaderHeight(WLength height)
-
getPageCount
public abstract int getPageCount()Returns the number of pages.When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data. This returns the number of pages currently shown.
- See Also:
getCreatePageNavigationBar()
,pageChanged()
-
getPageSize
public abstract int getPageSize()Returns the page size.When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data. This returns the number of items per page.
- See Also:
getCreatePageNavigationBar()
,pageChanged()
-
getCurrentPage
public abstract int getCurrentPage()Returns the current page.When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data. This returns the current page (between 0 and
getPageCount()
- 1).- See Also:
getCreatePageNavigationBar()
,pageChanged()
-
setCurrentPage
public abstract void setCurrentPage(int page)Sets the current page.When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data. This method can be used to change the current page.
- See Also:
getCreatePageNavigationBar()
,pageChanged()
-
scrollTo
Scrolls the view to an item.Scrolls the view to ensure that the item which represents the provided
index
is visible. Ahint
may indicate how the item should appear in the viewport (if possible).Note: Currently only implemented to scroll to the correct row, not taking into account the column.
-
scrollTo
Scrolls the view to an item.Calls
scrollTo(index, WAbstractItemView.ScrollHint.EnsureVisible)
-
setEditTriggers
Configures what actions should trigger editing.The default value is DoubleClicked.
- See Also:
edit(WModelIndex index)
-
setEditTriggers
public final void setEditTriggers(WAbstractItemView.EditTrigger editTrigger, WAbstractItemView.EditTrigger... editTriggers)Configures what actions should trigger editing.Calls
setEditTriggers(EnumSet.of(editTrigger, editTriggers))
-
getEditTriggers
Returns the editing triggers.- See Also:
setEditTriggers(EnumSet editTriggers)
-
setEditOptions
Configures editing options.The default value is SingleEditor;
-
setEditOptions
public final void setEditOptions(WAbstractItemView.EditOption editOption, WAbstractItemView.EditOption... editOptions)Configures editing options. -
getEditOptions
Returns the editing options.- See Also:
setEditOptions(EnumSet editOptions)
-
edit
Opens an editor for the given index.Unless multiple editors are enabled, any other open editor is closed first.
-
closeEditor
Closes the editor for the given index.If
saveData
is true, then the currently edited value is saved first to the model.- See Also:
edit(WModelIndex index)
-
closeEditor
Closes the editor for the given index.Calls
closeEditor(index, true)
-
closeEditors
public void closeEditors(boolean saveData)Closes all open editors.If
saveData
is true, then the currently edited values are saved to the model before closing the editor. -
closeEditors
public final void closeEditors()Closes all open editors.Calls
closeEditors(true)
-
validateEditor
Validates the editor for the given index.Validation is done by invoking
WAbstractItemDelegate#validate()
. -
validateEditors
Validates all editors.- See Also:
validateEditor(WModelIndex index)
-
isEditing
Returns whether an editor is open for a given index.- See Also:
edit(WModelIndex index)
-
isValid
Returns whether an editor's state is valid. -
clicked
Signal emitted when clicked.When the event happened over an item, the first argument indicates the item that was clicked on.
- See Also:
doubleClicked()
-
doubleClicked
Signal emitted when double clicked.When the event happened over an item, the first argument indicates the item that was double clicked on.
- See Also:
clicked()
-
mouseWentDown
Signal emitted when a mouse button is pressed down.This signal is emitted only when 'over' an item (the model index is passed as first argument is never invalid).
- See Also:
mouseWentUp()
-
mouseWentUp
Signal emitted when the mouse button is released.When the event happened over an item, the first argument indicates the item where the mouse went up.
- See Also:
mouseWentDown()
-
touchStart
Deprecated.UsetouchStarted()
instead.Signal emitted when a finger is placed on the screen.When the event happened over an item, the first argument indicates the item that was touched.
-
touchStarted
Signal emitted when one or more fingers are placed on the screen.When the event happened over an item, the first argument indicates the items that were touched. The indices in the model index vector match the indices in the
WTouchEvent.getChangedTouches()
. -
touchMoved
Signal emitted when one or more fingers are moved on the screen.When the event happened over an item, the first argument indicates the items that were touched. The indices in the model index vector match the indices in the
WTouchEvent.getChangedTouches()
. -
touchEnded
Signal emitted when one or more fingers are removed from the screen.When the event happened over an item, the first argument indicates the items where the touch ended. The indices in the model index vector match the indices in the
WTouchEvent.getChangedTouches()
.Note: When JavaScript is disabled, the signal will never fire.
-
selectionChanged
Signal emitted when the selection is changed. -
pageChanged
Signal emitted when page information was updated.When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data. This signal is emitted when page-related information changed (e.g. the current page was changed, or the number of rows was changed).
- See Also:
getCreatePageNavigationBar()
-
columnResized
Returns the signal emitted when a column is resized by the user.The arguments of the signal are: the column index and the new width of the column.
-
isSortEnabled
public boolean isSortEnabled()Returns whether the view is sortable.When enabeld the view can be sorted by clicking on the header.
-
setHeaderClickSortEnabled
public void setHeaderClickSortEnabled(boolean enabled)Alow to sort.When enabeld the view can be sorted by clicking on the header.
-
headerClicked
Signal emitted when a header item is clicked.The argument that is passed is the column number.
- See Also:
clicked()
-
headerDoubleClicked
Signal emitted when a header item is double clicked.The argument that is passed is the column number.
- See Also:
doubleClicked()
,headerClicked()
-
headerMouseWentDown
Signal emitted when a mouse button is pressed on a header itemThe argument that is passed is the column number.
-
headerMouseWentUp
Signal emitted when a mouse button is released on a header itemThe argument that is passed is the column number.
- See Also:
headerMouseWentDown()
-
scrolled
Signal emitted when scrolling.Note: Works only if ajax is available.
-
setRowHeaderCount
public void setRowHeaderCount(int count)Configures the number of columns that are used as row headers.An item view does not use the vertical header data from the model in any way, but instead you can configure data in the first column(s) to be used as a row headers.
These columns will not scroll horizontally together with the rest of the model.
The default value is 0.
Note: Currently, this property must be set before any other settings of the view and only a value of 0 or 1 is supported.
-
getRowHeaderCount
public int getRowHeaderCount()Returns the number of columns that are used as row headers.- See Also:
setRowHeaderCount(int count)
-
setColumn1Fixed
public void setColumn1Fixed(boolean enable)Deprecated.UsesetRowHeaderCount()
instead.Configures whether horizontal scrolling includes the first column (deprecated)To display a model with many columns, this option allows you to keep the first column fixed while scrolling through the other columns of the model.
The default value is
false
. -
isColumn1Fixed
public boolean isColumn1Fixed()Deprecated.UsegetRowHeaderCount()
instead.Returns whether horizontal scrolling includes the first column. (deprecated)- See Also:
setColumn1Fixed(boolean enable)
-
setObjectName
public void setObjectName(java.lang.String name)Description copied from class:WObject
Sets an object name.The object name can be used to easily identify a type of object in the DOM, and does not need to be unique. It will usually reflect the widget type or role. The object name is prepended to the auto-generated object
WObject.getId()
.The default object name is empty.
- Overrides:
setObjectName
in classWCompositeWidget
- Parameters:
name
- the object name.
-
keyWentDown
Event signal emitted when a keyboard key is pushed down.The keyWentDown signal is the first signal emitted when a key is pressed (before the keyPressed signal). Unlike
keyPressed()
however it is also emitted for modifier keys (such as "shift", "control", ...) or keyboard navigation keys that do not have a corresponding character.- See Also:
keyPressed()
,keyWentUp()
-
keyPressed
Event signal emitted when a "character" was entered.The keyPressed signal is emitted when a key is pressed, and a character is entered. Unlike
keyWentDown()
, it is emitted only for key presses that result in a character being entered, and thus not for modifier keys or keyboard navigation keys.- See Also:
keyWentDown()
-
keyWentUp
Event signal emitted when a keyboard key is released.This is the counter-part of the
keyWentDown()
event. Every key-down has its corresponding key-up.- See Also:
keyWentDown()
-
dropEvent
Handles a drop event (drag & drop).The
event
object contains details about the drop operation, identifying the source (which provides the data) and the mime-type of the data. The drop was received on thetarget
item.The drop event can be handled either by the view itself, or by the model. The default implementation checks if the mime-type is accepted by the model, and if so passes the drop event to the model. If the source is the view's own selection model, then the drop event will be handled as a
DropAction.MoveAction
, otherwise the drop event will be handled as aDropAction.CopyAction
. -
createExtraHeaderWidget
Create an extra widget in the header.You may reimplement this method to provide an extra widget to be placed below the header label. The extra widget will be visible only if a multi-line header is configured using
setHeaderHeight()
.The widget is created only once, but this method may be called repeatedly for a column for which prior calls returned
null
(i.e. each time the header is rerendered).The default implementation returns
null
. -
extraHeaderWidget
Returns the extra header widget.Returns the widget previously created using
createExtraHeaderWidget()
- See Also:
createExtraHeaderWidget(int column)
-
modelHeaderDataChanged
-
createHeaderWidget
-
handleTouchSelect
Handles a touch select event. -
handleTouchStart
Handles a touch started event. -
handleTouchMove
Handles a touch moved event. -
handleTouchEnd
Handles a touch ended event. -
shiftEditorRows
protected boolean shiftEditorRows(WModelIndex parent, int start, int count, boolean persistWhenShifted) -
shiftEditorColumns
protected boolean shiftEditorColumns(WModelIndex parent, int start, int count, boolean persistWhenShifted)
-
horizontalHeaderAlignment()
instead.