Package hudson.model

Class ListView

java.lang.Object
hudson.model.AbstractModelObject
hudson.model.View
hudson.model.ListView
All Implemented Interfaces:
ExtensionPoint, Describable<View>, DescriptorByNameOwner, DirectlyModifiableView, ModelObject, Saveable, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithChildren, HasWidgets
public class ListView extends View implements DirectlyModifiableView
Displays Jobs in a flat list view.
Author:
Kohsuke Kawaguchi

  • Constructor Details

    • ListView

      @DataBoundConstructor public ListView(String name)

    • ListView

      public ListView(String name, ViewGroup owner)

  • Method Details

    • setColumns

      @DataBoundSetter public void setColumns(List<ListViewColumn> columns) throws IOException
      Sets the columns of this view.
      Throws:
      IOException

    • setJobFilters

      @DataBoundSetter public void setJobFilters(List<ViewJobFilter> jobFilters) throws IOException
      Throws:
      IOException

    • readResolve

      protected Object readResolve()

    • initColumns

      protected void initColumns()

    • initJobFilters

      protected void initJobFilters()

    • hasJobFilterExtensions

      public boolean hasJobFilterExtensions()
      Used to determine if we want to display the Add button.

    • getJobFilters

      public DescribableList<ViewJobFilter,Descriptor<ViewJobFilter>> getJobFilters()

    • getColumns

      public DescribableList<ListViewColumn,Descriptor<ListViewColumn>> getColumns()
      Description copied from class: View
      If this view uses <t:projectView> for rendering, this method returns columns to be displayed.
      Overrides:
      getColumns in class View

    • getJobNames

      public Set<String> getJobNames()

    • getItems

      public List<TopLevelItem> getItems()
      Returns a read-only view of all Jobs in this view.

      This method returns a separate copy each time to avoid concurrent modification issue.

      Specified by:
      getItems in class View

    • makeSearchIndex

      public SearchIndexBuilder makeSearchIndex()
      Description copied from class: AbstractModelObject
      Default implementation that returns empty index.
      Overrides:
      makeSearchIndex in class View

    • contains

      public boolean contains(TopLevelItem item)
      Description copied from class: View
      Checks if the job is in this collection.
      Specified by:
      contains in class View

    • jobNamesContains

      public boolean jobNamesContains(TopLevelItem item)

    • add

      public void add(TopLevelItem item) throws IOException
      Adds the given item to this view.
      Specified by:
      add in interface DirectlyModifiableView
      Throws:
      IOException - Adding failed.
      Since:
      1.389

    • remove

      public boolean remove(TopLevelItem item) throws IOException
      Removes given item from this view.
      Specified by:
      remove in interface DirectlyModifiableView
      Returns:
      false if item not present in view, true if removed.
      Throws:
      IOException - Removal failed.
      Since:
      1.566

    • getIncludeRegex

      public String getIncludeRegex()

    • isRecurse

      public boolean isRecurse()

    • setRecurse

      @DataBoundSetter public void setRecurse(boolean recurse)
      Since:
      1.568

    • getStatusFilter

      @Deprecated public Boolean getStatusFilter()
      Deprecated.
      Status filter is now controlled via a ViewJobFilter, see StatusFilter
      Filter by enabled/disabled status of jobs. Null for no filter, true for enabled-only, false for disabled-only.

    • isAddToCurrentView

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public boolean isAddToCurrentView()
      Determines the initial state of the checkbox.
      Returns:
      true when the view is empty or already contains jobs specified by name.

    • doCreateItem

      @POST public Item doCreateItem(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
      Description copied from class: View
      Creates a new Item in this collection.

      This method should call ModifiableItemGroup.doCreateItem(StaplerRequest, StaplerResponse) and then add the newly created item to this view.

      Specified by:
      doCreateItem in class View
      Returns:
      null if fails.
      Throws:
      IOException
      javax.servlet.ServletException

    • doAddJobToView

      public org.kohsuke.stapler.HttpResponse doAddJobToView(@QueryParameter String name) throws IOException, javax.servlet.ServletException
      Description copied from interface: DirectlyModifiableView
      Handle addJobToView web method. This method should RequirePOST.
      Specified by:
      doAddJobToView in interface DirectlyModifiableView
      Parameters:
      name - Item name. This can be either full name relative to owner item group or full item name prefixed with '/'.
      Throws:
      IOException
      javax.servlet.ServletException

    • doRemoveJobFromView

      public org.kohsuke.stapler.HttpResponse doRemoveJobFromView(@QueryParameter String name) throws IOException, javax.servlet.ServletException
      Description copied from interface: DirectlyModifiableView
      Handle removeJobFromView web method. This method should RequirePOST.
      Specified by:
      doRemoveJobFromView in interface DirectlyModifiableView
      Parameters:
      name - Item name. This can be either full name relative to owner item group or full item name prefixed with '/'.
      Throws:
      IOException
      javax.servlet.ServletException

    • submit

      protected void submit(org.kohsuke.stapler.StaplerRequest req) throws javax.servlet.ServletException, Descriptor.FormException, IOException
      Handles the configuration submission. Load view-specific properties here.
      Specified by:
      submit in class View
      Throws:
      javax.servlet.ServletException
      Descriptor.FormException
      IOException

    • setIncludeRegex

      @DataBoundSetter public void setIncludeRegex(String includeRegex)
      Since:
      1.526

    • setJobNames

      @DataBoundSetter public void setJobNames(Set<String> jobNames)

    • setStatusFilter

      @Deprecated @DataBoundSetter public void setStatusFilter(Boolean statusFilter)
      Deprecated.
      Status filter is now controlled via a ViewJobFilter, see StatusFilter

    • getDefaultColumns

      @Deprecated public static List<ListViewColumn> getDefaultColumns()
      Deprecated.
      as of 1.391 Use ListViewColumn.createDefaultInitialColumnList()