public interface ViewGroup extends Saveable, ModelObject, AccessControlled
View
s.Modifier and Type | Method and Description |
---|---|
boolean |
canDelete(View view)
Determine whether a view may be deleted.
|
void |
deleteView(View view)
Deletes a view in this group.
|
default Collection<View> |
getAllViews()
Gets all the views in this group including nested views.
|
default ItemGroup<? extends TopLevelItem> |
getItemGroup()
Returns the
ItemGroup from which the views in this group should render items. |
default 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.
|
String |
getUrl()
Returns the path of this group, relative to the context root,
like "foo/bar/zot/".
|
View |
getView(String name)
Gets a view of the given name.
|
default List<Action> |
getViewActions()
Returns actions that should be displayed in views.
|
Collection<View> |
getViews()
Gets all the views in this group.
|
ViewsTabBar |
getViewsTabBar()
Gets the TabBar for the views.
|
void |
onViewRenamed(View view,
String oldName,
String newName)
View calls this method when it's renamed. |
getDisplayName
checkAnyPermission, checkPermission, getACL, hasAnyPermission, hasPermission, hasPermission, hasPermission2
boolean canDelete(View view)
void deleteView(View view) throws IOException
IOException
Collection<View> getViews()
@NonNull default Collection<View> getAllViews()
View getView(String name)
default View getPrimaryView()
If the view group doesn't do such rendering, this method can always return null.
String getUrl()
void onViewRenamed(View view, String oldName, String newName)
View
calls 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.
ViewsTabBar getViewsTabBar()
default ItemGroup<? extends TopLevelItem> getItemGroup()
ItemGroup
from which the views in this group should render items.
Generally speaking, Views render a subset of TopLevelItem
s that belong to this item group.
ModifiableItemGroup
(if the container allows arbitrary addition).
By default, Jenkins.getInstance()
.default List<Action> getViewActions()
In this interface, the return value is used read-only. This doesn't prevent subtypes from returning modifiable actions, however.
Jenkins.getActions()
by defaultActionable.getActions()
Copyright © 2004–2021. All rights reserved.