@Extension @Symbol(value={"file","fileParam"}) public static class FileParameterDefinition.DescriptorImpl extends ParameterDefinition.ParameterDescriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
clazz
Constructor and Description |
---|
DescriptorImpl() |
Modifier and Type | Method and Description |
---|---|
String |
getDisplayName()
Human readable name of this kind of configurable object.
|
String |
getHelpFile()
Returns the resource path to the help screen HTML, if any.
|
getValuePage
addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, 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
public String getDisplayName()
Descriptor
Class.getSimpleName()
on Descriptor.clazz
, so for example MyThing
from some.pkg.MyThing.DescriptorImpl
.
Historically some implementations returned null as a way of hiding the descriptor from the UI,
but this is generally managed by an explicit method such as isEnabled
or isApplicable
.getDisplayName
in class ParameterDefinition.ParameterDescriptor
public String getHelpFile()
Descriptor
Starting 1.282, this method uses "convention over configuration" — you should just put the "help.html" (and its localized versions, if any) in the same directory you put your Jelly view files, and this method will automatically does the right thing.
This value is relative to the context root of Hudson, so normally
the values are something like "/plugin/emma/help.html"
to
refer to static resource files in a plugin, or "/publisher/EmmaPublisher/abc"
to refer to Jelly script abc.jelly
or a method EmmaPublisher.doAbc()
.
getHelpFile
in class Descriptor<ParameterDefinition>
Copyright © 2004–2022. All rights reserved.