Package eu.webtoolkit.jwt

Class WStringListModel

java.lang.Object

eu.webtoolkit.jwt.WObject

eu.webtoolkit.jwt.WAbstractItemModel

eu.webtoolkit.jwt.WAbstractListModel

eu.webtoolkit.jwt.WStringListModel

public class WStringListModel
extends WAbstractListModel

An model that manages a list of strings.

This model only manages a unidimensional list of items and is optimized for usage by view widgets such as combo-boxes.

It supports all features of a typical item model, including data for multiple roles, editing and addition and removal of data rows.

You can populate the model by passing a list of strings to its consructor, or by using the setStringList() method. You can set or retrieve data using the setData() and getData() methods, and add or remove data using the insertRows() and removeRows() methods.

See Also:

• WComboBox
• WSelectionBox

Nested Class Summary

Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject

WObject.FormData

Constructor Summary

Constructors

Constructor	Description
WStringListModel()	Creates a new empty string list model.
WStringListModel(List<WString> strings)	Creates a new string list model.

Method Summary

Modifier and Type	Method	Description
void	addString(CharSequence string)	Adds a string.
Object	getData(WModelIndex index, ItemDataRole role)	Returns data at a specified model index for the given role.
EnumSet<ItemFlag>	getFlags(WModelIndex index)	Returns the flags for an item.
WModelIndex	getIndex(int row, int column, WModelIndex parent)	Returns the child index for the given row and column.
int	getRowCount(WModelIndex parent)	Returns the number of rows.
List<WString>	getStringList()	Returns the string list.
boolean	insertRows(int row, int count, WModelIndex parent)	Inserts one or more rows.
void	insertString(int row, CharSequence string)	Inserts a string.
boolean	removeRows(int row, int count, WModelIndex parent)	Removes rows.
boolean	setData(WModelIndex index, Object value, ItemDataRole role)	Sets data at the given model index.
final void	setFlags(int row, ItemFlag flag, ItemFlag... flags)	Sets model flags for an item.
void	setFlags(int row, EnumSet<ItemFlag> flags)	Sets model flags for an item.
void	setStringList(List<WString> strings)	Sets a new string list.
void	sort(int column, SortOrder order)	Sorts the model.

Methods inherited from class eu.webtoolkit.jwt.WAbstractListModel

getColumnCount, getParent

Methods inherited from class eu.webtoolkit.jwt.WAbstractItemModel

beginInsertColumns, beginInsertRows, beginRemoveColumns, beginRemoveRows, collapseColumn, columnsAboutToBeInserted, columnsAboutToBeRemoved, columnsInserted, columnsRemoved, copyData, createIndex, createIndex, dataChanged, dropEvent, dropEvent, endInsertColumns, endInsertRows, endRemoveColumns, endRemoveRows, expandColumn, fromRawIndex, getAcceptDropMimeTypes, getColumnCount, getData, getData, getData, getData, getHeaderData, getHeaderData, getHeaderData, getHeaderFlags, getHeaderFlags, getIndex, getItemData, getMimeType, getRowCount, hasChildren, hasIndex, hasIndex, headerDataChanged, insertColumn, insertColumn, insertColumns, insertColumns, insertRow, insertRow, insertRows, layoutAboutToBeChanged, layoutChanged, match, modelReset, removeColumn, removeColumn, removeColumns, removeColumns, removeRow, removeRow, removeRows, reset, rowsAboutToBeInserted, rowsAboutToBeRemoved, rowsInserted, rowsRemoved, setData, setData, setData, setData, setHeaderData, setHeaderData, setHeaderData, setItemData, sort, toRawIndex

Methods inherited from class eu.webtoolkit.jwt.WObject

getId, getObjectName, remove, resendFormData, setFormData, setObjectName, tr

Methods inherited from class java.lang.Object

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

Constructor Details

WStringListModel

public WStringListModel()

Creates a new empty string list model.

WStringListModel

public WStringListModel(List<WString> strings)

Creates a new string list model.

Method Details

setStringList

public void setStringList(List<WString> strings)

Sets a new string list.

Replaces the current string list with a new list.

See Also:

• WAbstractItemModel.dataChanged()
• addString(CharSequence string)

insertString

public void insertString(int row,
 CharSequence string)

Inserts a string.

See Also:

• setStringList(List strings)

addString

public void addString(CharSequence string)

Adds a string.

See Also:

• setStringList(List strings)

getStringList

public List<WString> getStringList()

Returns the string list.

See Also:

• setStringList(List strings)

setFlags

public void setFlags(int row,
 EnumSet<ItemFlag> flags)

Sets model flags for an item.

The default item flags are ItemFlag.Selectable | ItemFlag.Editable.

setFlags

public final void setFlags(int row,
 ItemFlag flag,
 ItemFlag... flags)

Sets model flags for an item.

Calls setFlags(row, EnumSet.of(flag, flags))

getFlags

public EnumSet<ItemFlag> getFlags(WModelIndex index)

Returns the flags for an item.

This method is reimplemented to return flags set in setFlags().

Overrides:

getFlags in class WAbstractItemModel

See Also:

• setFlags(int row, EnumSet flags)

getIndex

public WModelIndex getIndex(int row,
 int column,
 WModelIndex parent)

Description copied from class: WAbstractItemModel

Returns the child index for the given row and column.

When implementing this method, you can use createIndex() to create an index that corresponds to the item at row and column within parent.

If the location is invalid (out of bounds at the parent), then an invalid index must be returned.

Overrides:

getIndex in class WAbstractListModel

See Also:

• WAbstractItemModel.getParent(WModelIndex index)

setData

public boolean setData(WModelIndex index,
 Object value,
 ItemDataRole role)

Description copied from class: WAbstractItemModel

Sets data at the given model index.

Returns true if the operation was successful.

The default implementation returns false.

The model implementation must emit the dataChanged() signal after data was changed.

Overrides:

setData in class WAbstractItemModel

See Also:

• WAbstractItemModel.getData(WModelIndex index, ItemDataRole role)

getData

public Object getData(WModelIndex index,
 ItemDataRole role)

Description copied from class: WAbstractItemModel

Returns data at a specified model index for the given role.

You should check the role to decide what data to return. Usually a View class will ask for data for several roles which affect not only the contents (ItemDataRole.Display) but also icons (ItemDataRole.Decoration), URLs (ItemDataRole.Link), and other visual aspects. If your item does not specify data for a particular role, it should simply return a Wt::cpp17::any().

Specified by:

getData in class WAbstractItemModel

See Also:

• WAbstractItemModel.getFlags(WModelIndex index)
• WAbstractItemModel.getHeaderData(int section, Orientation orientation, ItemDataRole role)
• WAbstractItemModel.setData(WModelIndex index, Object value, ItemDataRole role)

getRowCount

public int getRowCount(WModelIndex parent)

Description copied from class: WAbstractItemModel

Returns the number of rows.

This returns the number of rows at index parent.

Specified by:

getRowCount in class WAbstractItemModel

See Also:

• WAbstractItemModel.getColumnCount(WModelIndex parent)

insertRows

public boolean insertRows(int row,
 int count,
 WModelIndex parent)

Description copied from class: WAbstractItemModel

Inserts one or more rows.

In models that support row insertion, this inserts count rows, starting at row, and returns true if the operation was successful. The new rows are inserted under parent.

If parent had no children, then a single column is added with count rows.

The default implementation returns false.

The model implementation must call beginInsertRows() and endInsertRows() before and after the operation whenever its geometry is changed by inserting rows. This emits signals for views to properly react to these changes.

Overrides:

insertRows in class WAbstractItemModel

See Also:

• WAbstractItemModel.insertColumns(int column, int count, WModelIndex parent)
• WAbstractItemModel.removeRows(int column, int count, WModelIndex parent)
• WAbstractItemModel.beginInsertRows(WModelIndex parent, int first, int last)
• WAbstractItemModel.endInsertRows()

removeRows

public boolean removeRows(int row,
 int count,
 WModelIndex parent)

Description copied from class: WAbstractItemModel

Removes rows.

Returns true if the operation was successful.

The default implementation returns false.

The model implementation must call beginRemoveRows() and endRemoveRows() before and after the operation whenever its geometry is changed by removing rows. This emits signals for views to properly react to these changes.

Overrides:

removeRows in class WAbstractItemModel

See Also:

• WAbstractItemModel.removeColumns(int column, int count, WModelIndex parent)
• WAbstractItemModel.insertRows(int column, int count, WModelIndex parent)
• WAbstractItemModel.beginRemoveRows(WModelIndex parent, int first, int last)
• WAbstractItemModel.endRemoveRows()

sort

public void sort(int column,
 SortOrder order)

Sorts the model.

The column is ignored, as this model only holds a singular list. It will always result in the first (and only) column of the model being sorted.

Overrides:

sort in class WAbstractItemModel

See Also:

• WAbstractItemModel.layoutAboutToBeChanged()
• WAbstractItemModel.layoutChanged()