- All Implemented Interfaces:
public class MyViewsProperty extends UserProperty implements ModifiableViewGroup, Action, org.kohsuke.stapler.StaplerFallbackA UserProperty that remembers user-private views.
- Tom Huybrechts
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
canDelete(View view)Determine whether a view may be deleted.
deleteView(View view)Deletes a view in this group.
doCreateView(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
doViewExistsCheck(String value, boolean exists)Checks if a private view with the given name exists.
getACL()Obtains the ACL associated with this object.
getDisplayName()Gets the string to be displayed.
getIconFileName()Gets the name of the icon.
getPrimaryView()If the view group renders one view in its own URL (like Jenkins top page does), then that view is called the primary view.
getUrl()Returns the path of this group, relative to the context root, like "foo/bar/zot/".
getUrlName()Gets the URL path name.
getView(String name)Gets a view of the given name.
getViewActions()Returns actions that should be displayed in views.
getViews()Gets all the views in this group.
getViewsTabBar()Gets the TabBar for the views.
onViewRenamed(View view, String oldName, String newName)
Viewcalls this method when it's renamed.
reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form)When a parent/owner object of a Describable gets a config form submission and instances are recreated, this method is invoked on the existing instance (meaning the 'this' reference points to the existing instance) to create a new instance to be added to the parent/owner object.
save()Persists the state of this object into XML.
setPrimaryViewName(String primaryViewName)Sets the primary view.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface hudson.security.AccessControlled
checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2
@DataBoundConstructor public MyViewsProperty(@CheckForNull String primaryViewName)
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public Object readResolve()
@CheckForNull public String getPrimaryViewName()
public void setPrimaryViewName(@CheckForNull String primaryViewName)Sets the primary view.
primaryViewName- Name of the primary view to be set.
nullto make the primary view undefined.
public User getUser()
public String getUrl()Returns the path of this group, relative to the context root, like "foo/bar/zot/". Note no leading slash but trailing slash.
public void save() throws IOExceptionDescription copied from interface:
SaveablePersists the state of this object into XML.
For making a bulk change efficiently, see
To support listeners monitoring changes to this object, call
public Collection<View> getViews()Gets all the views in this group.
getViewGets a view of the given name. This also creates the URL binding for views (in the form of ".../view/FOOBAR/...")
public boolean canDelete(View view)Determine whether a view may be deleted.
public void deleteView(View view) throws IOExceptionDeletes a view in this group.
Viewcalls this method when it's renamed. This method is intended to work as a notification to the
ViewGroup(so that it can adjust its internal data structure, for example.)
It is the caller's responsibility to ensure that the new name is a legal view name.
public void addView(View view) throws IOExceptionDescription copied from interface:
public View getPrimaryView()If the view group renders one view in its own URL (like Jenkins top page does), then that view is called the primary view. In this case, the hyperlink to the primary view points to the view group itself.
If the view group doesn't do such rendering, this method can always return null.
public org.kohsuke.stapler.HttpResponse doIndex()
@POST public void doCreateView(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException, ParseException, Descriptor.FormException
public FormValidation doViewExistsCheck(@QueryParameter String value, @QueryParameter boolean exists)Checks if a private view with the given name exists. An error is returned if exists==true but the view does not exist. An error is also returned if exists==false but the view does exist.
public ACL getACL()Description copied from interface:
AccessControlledObtains the ACL associated with this object.
public String getDisplayName()Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".
public String getIconFileName()Gets the name of the icon.
- Specified by:
- If the icon name is prefixed with "symbol-", a Jenkins Symbol
will be used.
If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside
/images/24x24. This is useful for using one of the stock images.
If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif"), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.
Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute
floatBox.jellyand no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.
- See Also:
- Jenkins Symbols,
public String getUrlName()Gets the URL path name.
For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.
This method should return a string that's unique among other
The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.
If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.
public UserProperty reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form) throws Descriptor.FormExceptionDescription copied from interface:
ReconfigurableDescribableWhen a parent/owner object of a Describable gets a config form submission and instances are recreated, this method is invoked on the existing instance (meaning the 'this' reference points to the existing instance) to create a new instance to be added to the parent/owner object.
The default implementation of this should be the following:
return form==null ? null : getDescriptor().newInstance(req, form);
- Specified by:
req- The current HTTP request being processed.
form- JSON fragment that corresponds to this describable object. If the newly submitted form doesn't include a fragment for this describable (meaning the user has de-selected your descriptor), then this argument is null.
- The new instance. To not to create an instance of a describable, return null.
public ViewsTabBar getViewsTabBar()Gets the TabBar for the views. TabBar for views can be provided by extension. Only one TabBar can be active at a given time (Selectable by user in the global Configuration page). Default TabBar is provided by Hudson Platform.
getViewActionsReturns actions that should be displayed in views.
In this interface, the return value is used read-only. This doesn't prevent subtypes from returning modifiable actions, however.
public Object getStaplerFallback()
- Specified by:
public MyViewsTabBar getMyViewsTabBar()