vi.widgets.list

Module Contents

Classes

ListWidget

Provides the interface to list-applications.

ViewportListWidget

Provides the interface to list-applications.

class vi.widgets.list.ListWidget(module, filter=None, columns=None, filterID=None, filterDescr=None, batchSize=None, context=None, autoload=True, *args, **kwargs)

Bases: flare.html5.Div

Provides the interface to list-applications. It acts as a data-provider for a DataTable and binds an action-bar to this table.

setSelector(callback, multi=True, allow=None)

Configures the widget as selector for a relationalBone and shows it.

selectorReturn()

Returns the current selection to the callback configured with setSelector.

tableInitialization(*args, **kwargs)

Instantiates the table :param args: ListWidget Parameter :param kwargs: ListWidget Parameter :return:

setAmount(amount)
setPage(page=0)

sets targetpage. if not enougth loadedpages this pages will be requested :param page: sets targetpage :return:

onRequestingFinished(*args, **kwargs)
onClick(event)
setTableActionBar()
getDefaultEntryActions()

Returns the list of actions available in our actionBar

getActions()

Returns the list of actions available in our actionBar

getAllActions(view=None)

Returns the list of actions available in the action bar.

showErrorMsg(req=None, code=None)

Removes all currently visible elements and displayes an error message

onNextBatchNeeded()

Requests the next rows from the server and feed them to the table.

onAttach()
onDetach()
onDataChanged(module, *args, **kwargs)

Refresh our view if element(s) in this module have changed

requestStructure()
receivedStructure(resp)
reloadData()

Removes all currently displayed data and refetches the first batch from the server.

setFilter(filter, filterID=None, filterDescr=None)

Applies a new filter.

setContext(context)

Applies a new context.

getFilter()
updateEmptyNotification()
onCompletion(req)

Pass the rows received to the datatable. :param req: The network request that succeed.

setFields(fields)
getFields()
onSelectionActivated(table, selection)
activateSelection()
static canHandle(moduleName, moduleInfo)
class vi.widgets.list.ViewportListWidget(module, filter=None, columns=None, filterID=None, filterDescr=None, batchSize=None, context=None, autoload=True, *args, **kwargs)

Bases: ListWidget

Provides the interface to list-applications. It acts as a data-provider for a DataTable and binds an action-bar to this table.

tableInitialization(*args, **kwargs)

Instantiates the table :param args: ListWidget Parameter :param kwargs: ListWidget Parameter

Override explanation
  • use ViewPort DataTable with rows parameter

setAmount(amount)
setPage(page=0)

sets targetpage. if not enougth loadedpages this pages will be requested else

Parameters:

page – sets targetpage

Returns:

_setPage(page=0)

render page to table :param page: :return:

onRequestingFinished(*args, **kwargs)
setTableActionBar()
static canHandle(moduleName, moduleInfo)