Package hudson.plugins.view.dashboard

Class Dashboard

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.View

hudson.model.ListView

hudson.plugins.view.dashboard.Dashboard

All Implemented Interfaces:

ExtensionPoint, Describable<View>, DescriptorByNameOwner, DirectlyModifiableView, ModelObject, Saveable, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithChildren, HasWidgets

public class Dashboard
extends ListView

View that can be customized with portlets to show the selected jobs information in various ways.

Author:

Peter Hayes

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Dashboard.DescriptorImpl

Nested classes/interfaces inherited from class hudson.model.ListView

ListView.Listener

Nested classes/interfaces inherited from class hudson.model.View

View.PropertyList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.View

CONFIGURE, CREATE, DELETE, description, filterExecutors, filterQueue, LIST, name, NEW_PRONOUN, owner, PERMISSIONS, READ, SORTER

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
Dashboard(String name)

Method Summary

Modifier and Type	Method	Description
List<DashboardPortlet>	getBottomPortlets()
DescriptorExtensionList<DashboardPortlet,Descriptor<DashboardPortlet>>	getDashboardPortletDescriptors()	Deprecated.
List<Job>	getJobs()
List<DashboardPortlet>	getLeftPortlets()
String	getLeftPortletWidth()
String	getPortletUrl(DashboardPortlet portlet)
List<DashboardPortlet>	getRightPortlets()
String	getRightPortletWidth()
List<Descriptor<DashboardPortlet>>	getSortedDashboardPortletDescriptors()
List<DashboardPortlet>	getTopPortlets()
boolean	HasItem(TopLevelItem item)	Deprecated.
boolean	isHideJenkinsPanels()
boolean	isIncludeStdJobList()
boolean	isUseCssStyle()
void	rename(String newName)
void	setBottomPortlets(List<DashboardPortlet> bottomPortlets)
void	setHideJenkinsPanels(boolean hideJenkinsPanels)
void	setIncludeStdJobList(boolean includeStdJobList)
void	setLeftPortlets(List<DashboardPortlet> leftPortlets)
void	setLeftPortletWidth(String leftPortletWidth)
void	setRightPortlets(List<DashboardPortlet> rightPortlets)
void	setRightPortletWidth(String rightPortletWidth)
void	setTopPortlets(List<DashboardPortlet> topPortlets)
void	setUseCssStyle(boolean useCssStyle)
protected void	submit(org.kohsuke.stapler.StaplerRequest2 req)

Methods inherited from class hudson.model.ListView

add, contains, doAddJobToView, doCreateItem, doRemoveJobFromView, getColumns, getDefaultColumns, getIncludeRegex, getItems, getJobFilters, getJobNames, getStatusFilter, hasJobFilterExtensions, initColumns, initJobFilters, isAddToCurrentView, isRecurse, jobNamesContains, makeSearchIndex, readResolve, remove, setColumns, setIncludeRegex, setJobFilters, setJobNames, setRecurse, setStatusFilter, submit

Methods inherited from class hudson.model.View

all, allInstantiable, create, create, createViewFromXML, doCheckJobName, doChildrenContextMenu, doConfigDotXml, doConfigDotXml, doConfigSubmit, doCreateItem, doDoDelete, doItemCategories, doRssAll, doRssFailed, doRssLatest, doSubmitDescription, doSubmitDescription, getAbsoluteUrl, getACL, getActions, getAllItems, getAllProperties, getApi, getApplicablePropertyDescriptors, getApproximateQueueItemsQuickly, getBuilds, getComputers, getDescription, getDescriptor, getDisplayName, getDynamic, getIndenter, getItem, getItemCreatePermission, getJob, getNewPronoun, getOwner, getOwnerItemGroup, getOwnerPrimaryView, getOwnerViewActions, getPostConstructLandingPage, getProperties, getQueueItems, getSearchUrl, getTimeline, getUrl, getViewName, getViewUrl, getVisiblePropertyDescriptors, isAutomaticRefreshEnabled, isDefault, isEditable, isFilterExecutors, isFilterQueue, makeSearchIndex, onJobRenamed, registerPermissions, save, setDescription, setFilterExecutors, setFilterQueue, toString, updateByXml, updateTransientActions, writeXml

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Methods inherited from interface jenkins.widgets.HasWidgets

getWidget, getWidgets

Methods inherited from interface jenkins.model.ModelObjectWithChildren

doChildrenContextMenu

Constructor Details

Dashboard

@DataBoundConstructor
public Dashboard(String name)

Method Details

isUseCssStyle

public boolean isUseCssStyle()

isIncludeStdJobList

public boolean isIncludeStdJobList()

setIncludeStdJobList

@DataBoundSetter
public void setIncludeStdJobList(boolean includeStdJobList)

Since:

2.13

isHideJenkinsPanels

public boolean isHideJenkinsPanels()

getLeftPortlets

@StaplerDispatchable
public List<DashboardPortlet> getLeftPortlets()

getRightPortlets

@StaplerDispatchable
public List<DashboardPortlet> getRightPortlets()

getTopPortlets

@StaplerDispatchable
public List<DashboardPortlet> getTopPortlets()

getBottomPortlets

@StaplerDispatchable
public List<DashboardPortlet> getBottomPortlets()

getLeftPortletWidth

public String getLeftPortletWidth()

getRightPortletWidth

public String getRightPortletWidth()

setUseCssStyle

@DataBoundSetter
public void setUseCssStyle(boolean useCssStyle)

setHideJenkinsPanels

@DataBoundSetter
public void setHideJenkinsPanels(boolean hideJenkinsPanels)

setLeftPortletWidth

@DataBoundSetter
public void setLeftPortletWidth(String leftPortletWidth)

setRightPortletWidth

@DataBoundSetter
public void setRightPortletWidth(String rightPortletWidth)

setLeftPortlets

@DataBoundSetter
public void setLeftPortlets(List<DashboardPortlet> leftPortlets)

setRightPortlets

@DataBoundSetter
public void setRightPortlets(List<DashboardPortlet> rightPortlets)

setTopPortlets

@DataBoundSetter
public void setTopPortlets(List<DashboardPortlet> topPortlets)

setBottomPortlets

@DataBoundSetter
public void setBottomPortlets(List<DashboardPortlet> bottomPortlets)

getPortletUrl

public String getPortletUrl(DashboardPortlet portlet)

getDashboardPortletDescriptors

@Deprecated
public DescriptorExtensionList<DashboardPortlet,Descriptor<DashboardPortlet>> getDashboardPortletDescriptors()

Deprecated.

getSortedDashboardPortletDescriptors

public List<Descriptor<DashboardPortlet>> getSortedDashboardPortletDescriptors()

HasItem

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public boolean HasItem(TopLevelItem item)

Deprecated.

getJobs

public List<Job> getJobs()

submit

protected void submit(org.kohsuke.stapler.StaplerRequest2 req)
               throws IOException,
jakarta.servlet.ServletException,
Descriptor.FormException

Overrides:

submit in class ListView

Throws:

IOException

jakarta.servlet.ServletException

Descriptor.FormException

rename

public void rename(String newName)
            throws Descriptor.FormException

Overrides:

rename in class View

Throws:

Descriptor.FormException