jenkins.model

Interface ModelObjectWithContextMenu

All Superinterfaces:

ModelObject

All Known Implementing Classes:

AbstractBuild, AbstractCloudComputer, AbstractCloudImpl, AbstractItem, AbstractProject, AbstractTopLevelItem, Actionable, Build, Cloud, Computer, FreeStyleBuild, FreeStyleProject, Hudson, Hudson.MasterComputer, Jenkins, Jenkins.MasterComputer, Job, Label, LabelAtom, LabelExpression, LabelExpression.And, LabelExpression.Binary, LabelExpression.Iff, LabelExpression.Implies, LabelExpression.Not, LabelExpression.Or, LabelExpression.Paren, Project, Queue.BlockedItem, Queue.BuildableItem, Queue.Item, Queue.LeftItem, Queue.NotWaitingItem, Queue.WaitingItem, Run, SlaveComputer, User, ViewJob

public interface ModelObjectWithContextMenu
extends ModelObject

ModelObject that has context menu in the breadcrumb.

When the user is visiting a particular page, all the ancestor objects that has ModelObject appears in the breadcrumbs. Among those which that also implements ModelObjectWithContextMenu shows the drop-down menu for providing quicker access to the actions to those objects.

Author:

Kohsuke Kawaguchi

See Also:

ModelObjectWithChildren

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ModelObjectWithContextMenu.ContextMenu Data object that represents the context menu.
static interface	ModelObjectWithContextMenu.ContextMenuVisibility Allows an action to decide whether it will be visible in a context menu.
static class	ModelObjectWithContextMenu.MenuItem Menu item in ModelObjectWithContextMenu.ContextMenu

Method Summary

Modifier and Type	Method and Description
ModelObjectWithContextMenu.ContextMenu	doContextMenu(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Generates the context menu.

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Method Detail

doContextMenu

ModelObjectWithContextMenu.ContextMenu doContextMenu(org.kohsuke.stapler.StaplerRequest request,
                                                     org.kohsuke.stapler.StaplerResponse response)
                                              throws Exception

Generates the context menu. The typical implementation is return new ContextMenu().from(this,request,response);, which implements the default behaviour. See ModelObjectWithContextMenu.ContextMenu.from(ModelObjectWithContextMenu, StaplerRequest, StaplerResponse) for more details of what it does. This should suit most implementations.

Throws:

Exception