l.c.b.b.BranchListingView(LaunchpadFormView, FeedsMixin) : class documentation

Part of lp.code.browser.branchlisting View In Hierarchy

Known subclasses: lp.code.browser.branchlisting.BaseSourcePackageBranchesView, lp.code.browser.branchlisting.NoContextBranchListingView, lp.code.browser.branchlisting.PersonBaseBranchListingView, lp.code.browser.branchlisting.ProductBranchListingView, lp.code.browser.branchlisting.ProjectBranchesView, lp.code.browser.branchlisting.SourcePackageBranchesView

A base class for views of branch listings.
Method show_git_link Undocumented
Method template Undocumented
Method initial_values Override this in your subclass if you want any widgets to have
Method selected_lifecycle_status Undocumented
Method branches All branches related to this target, sorted for display.
Method getVisibleBranchesForUser Get branches visible to the user.
Method hasAnyBranchesVisibleByUser Does the context have any branches that are visible to the user?
Method branch_count The number of total branches the user can see.
Method is_branch_count_zero Is the number of total branches the user can see zero?.
Method no_branch_message This may also be overridden in derived classes to provide
Method branch_listing_sort_values The enum items we should present in the 'sort_by' widget.
Method sort_by_field The zope.schema field for the 'sort_by' widget.
Method sort_by The value of the sort_by widget, or None if none was present.
Method setUpWidgets Set up the 'sort_by' widget with only the applicable choices.
Method default_information_type The default information type for new branches.
Method default_information_type_title The title of the default information type for new branches.
Method default_information_type_is_private The title of the default information type for new branches.
Method _getCollection Override this to say what branches will be in the listing.
Method _branches Return a sequence of branches.

Inherited from LaunchpadFormView:

Method __init__ Undocumented
Method initialize Undocumented
Method render Return the body of the response.
Method extendFields Allow subclasses to extend the form fields.
Method setUpFields Undocumented
Method help_links Dictionary mapping field names to help links.
Method adapters Provide custom adapters for use when setting up the widgets.
Method action_url Set the default action URL for the form.
Method has_available_actions Does the view have any available actions that will render?
Method addError Add a form wide error.
Method getFieldError Get the error associated with a particular field.
Method setFieldError Set the error associated with a particular field.
Static Method validate_none Do not do any validation.
Method validate_widgets Validate the named form widgets.
Method error_count Undocumented
Method ajax_failure_handler Called by the form if validate() finds any errors.
Method validate Validate the form.
Method validate_cancel Noop validation in case we cancel.
Method focusedElementScript Helper function to construct the script element content.
Method isSingleLineLayout Undocumented
Method isMultiLineLayout Undocumented
Method isCheckBoxLayout Undocumented
Method showOptionalMarker Should the (Optional) marker be shown?
Method _processNotifications Add any notification messages to the response headers.
Method _abort Abort the form edit.
Method _validate Check all widgets and perform any custom validation.

Inherited from FeedsMixin:

Method feed_links Undocumented
@property
def show_git_link(self):
Undocumented
@property
def template(self):
Undocumented
@property
def initial_values(self):
Override this in your subclass if you want any widgets to have initial values.
@cachedproperty
def selected_lifecycle_status(self):
Undocumented
def branches(self):
All branches related to this target, sorted for display.
def getVisibleBranchesForUser(self):
Get branches visible to the user.

This method is called from the BranchListingBatchNavigator to get the branches to show in the listing.

def hasAnyBranchesVisibleByUser(self):
Does the context have any branches that are visible to the user?
def _getCollection(self):
Override this to say what branches will be in the listing.
@cachedproperty
def branch_count(self):
The number of total branches the user can see.
@cachedproperty
def is_branch_count_zero(self):
Is the number of total branches the user can see zero?.
def _branches(self, lifecycle_status, sort_by=None):
Return a sequence of branches.

This method is overridden in the derived classes to perform the specific query.

Parameterslifecycle_statusA filter of the branch's lifecycle status.
@property
def no_branch_message(self):
This may also be overridden in derived classes to provide context relevant messages if there are no branches returned.
@property
def branch_listing_sort_values(self):
The enum items we should present in the 'sort_by' widget.

Subclasses get the chance to avoid some sort options (it makes no sense to offer to sort the product branch listing by product name!) and if we're filtering to a single lifecycle status it doesn't make much sense to sort by lifecycle.

@property
def sort_by_field(self):
The zope.schema field for the 'sort_by' widget.
@property
def sort_by(self):
The value of the sort_by widget, or None if none was present.
def setUpWidgets(self, context=None):
Set up the 'sort_by' widget with only the applicable choices.
@cachedproperty
def default_information_type(self):
The default information type for new branches.
@property
def default_information_type_title(self):
The title of the default information type for new branches.
@property
def default_information_type_is_private(self):
The title of the default information type for new branches.
API Documentation for Launchpad, generated by pydoctor at 2019-07-18 00:00:05.