reviewboard.datagrids.grids¶

class ShowClosedReviewRequestsMixin[source]¶

A mixin for showing or hiding closed review requests.

load_extra_state(profile, allow_hide_closed=True)[source]¶

Load extra state for the datagrid.

class DataGridJSMixin(*args, **kwargs)[source]¶

Mixin that provides enhanced JavaScript support for datagrids.

This contains additional information on the JavaScript views/models to load for the page, allowing for enhanced functionality in datagrids.

css_bundle_names = [][source]¶

A list of extra CSS static bundles to load on the page.

js_bundle_names = [][source]¶

A list of extra JavaScript static bundles to load on the page.

js_model_class = 'RB.DatagridPage'[source]¶

The JavaScript Model to use for the page state.

js_view_class = 'RB.DatagridPageView'[source]¶

The JavaScript View to use for the page rendering.

periodic_reload = False[source]¶

Whether or not to periodically reload the contents of the datagrid.

extra_js_model_data = None[source]¶

Extra data to pass to the JavaScript Model.

get_js_model_attrs()[source]¶

Return attributes for the JavaScript model.

These will be passed to the model specified in js_model_class during construction.

Subclasses can override this to provide additional data.

Returns

Attributes to provide to the JavaScript model.

Return type

dict

get_js_model_options()[source]¶

Return options for the JavaScript model.

These will be passed to the model specified in js_model_class during construction.

Subclasses can override this to provide additional data.

Returns

Options to provide to the JavaScript model.

Return type

dict

get_js_view_options()[source]¶

Return options for the JavaScript view.

These will be passed to the view specified in js_view_class during construction.

Subclasses can override this to provide additional data.

Returns

Options to provide to the JavaScript view.

Return type

dict

class DataGrid(*args, **kwargs)[source]¶

Base class for a datagrid in Review Board.

This contains additional information on JavaScript views/models to load for the page.

class AlphanumericDataGrid(*args, **kwargs)[source]¶

Base class for an alphanumeric datagrid in Review Board.

This contains additional information on JavaScript views/models to load for the page.

class ReviewRequestDataGrid(*args, **kwargs)[source]¶

A datagrid that displays a list of review requests.

This datagrid accepts the show_closed parameter in the URL, allowing submitted review requests to be filtered out or displayed.

load_extra_state(profile, allow_hide_closed=True)[source]¶

Load extra state for the datagrid.

post_process_queryset(queryset)[source]¶

Add additional data to the queryset.

link_to_object(state, obj, value)[source]¶

Return a link to the given object.

class ReviewDataGrid(*args, **kwargs)[source]¶

A datagrid that displays a list of reviews.

This datagrid accepts the show_closed parameter in the URL, allowing submitted review requests to be filtered out or displayed.

class DashboardDataGrid(*args, **kwargs)[source]¶

Displays the dashboard.

The dashboard is the main place where users see what review requests are out there that may need their attention.

load_extra_state(profile)[source]¶

Load extra state for the datagrid.

class UsersDataGrid(request, queryset=<QuerySet [<User: admin>, <User: doc>, <User: dopey>, <User: grumpy>]>, title='All users', local_site=None)[source]¶

A datagrid showing a list of users registered on Review Board.

link_to_object(state, obj, value)[source]¶

Return a link to the given object.

load_extra_state(profile)[source]¶

Load extra state for the datagrid.

This handles hiding or showing inactive users.

Parameters

profile (reviewboard.accounts.models.Profile) – The user profile which contains some basic configurable settings.

Returns

Always returns False.

Return type

bool

class GroupDataGrid(request, title='All groups', *args, **kwargs)[source]¶

A datagrid showing a list of review groups accessible by the user.

static link_to_object(state, obj, value)[source]¶

Return a link to the given object.

class UserPageDataGridMixin[source]¶

An abstract class for data grids on the user page.

This will display information about the user on the side.

class UserPageReviewRequestDataGrid(request, user, *args, **kwargs)[source]¶

A data grid for the user page.

This will show the review requests the user has out for review.

class UserPageReviewsDataGrid(request, user, *args, **kwargs)[source]¶

A data grid for the user page.

This will show reviews the user has made on other review requests.