public abstract class ViewDescriptor extends Descriptor<View>
Descriptor
for View
.Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
clazz
Modifier | Constructor and Description |
---|---|
protected |
ViewDescriptor() |
protected |
ViewDescriptor(Class<? extends View> clazz) |
Modifier and Type | Method and Description |
---|---|
protected FormValidation |
checkDisplayName(View view,
String value)
Validation of the display name field.
|
AutoCompletionCandidates |
doAutoCompleteCopyNewItemFrom(String value,
ItemGroup<?> container)
Auto-completion for the "copy from" field in the new job page.
|
List<Descriptor<ListViewColumn>> |
getColumnsDescriptors()
Possible
ListViewColumnDescriptor s that can be used with this view. |
String |
getDisplayName()
Returns the human-readable name of this type of view.
|
List<Descriptor<ViewJobFilter>> |
getJobFiltersDescriptors()
Possible
ViewJobFilter types that can be used with this view. |
String |
getNewViewDetailPage()
Jelly fragment included in the "new view" page.
|
boolean |
isApplicable(Class<? extends ViewGroup> ownerType)
|
boolean |
isApplicableIn(ViewGroup owner)
|
boolean |
isInstantiable()
Some special views are not instantiable, and for those
this method returns false.
|
addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
@NonNull public String getDisplayName()
getDisplayName
in class Descriptor<View>
public boolean isInstantiable()
public final String getNewViewDetailPage()
@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) public AutoCompletionCandidates doAutoCompleteCopyNewItemFrom(@QueryParameter String value, @AncestorInPath ItemGroup<?> container)
public List<Descriptor<ListViewColumn>> getColumnsDescriptors()
ListViewColumnDescriptor
s that can be used with this view.public List<Descriptor<ViewJobFilter>> getJobFiltersDescriptors()
ViewJobFilter
types that can be used with this view.protected FormValidation checkDisplayName(@NonNull View view, @CheckForNull String value)
view
- the view to check the new display name of.value
- the proposed new display name.public boolean isApplicable(Class<? extends ViewGroup> ownerType)
View
type is applicable to the given ViewGroup
type.
Default implementation returns true
always.
public boolean isApplicableIn(ViewGroup owner)
View
type is applicable in the specific ViewGroup
.
Default implementation returns isApplicable(Class)
for the ViewGroup
’s Object.getClass()
.
Copyright © 2004–2022. All rights reserved.