public abstract class ConsoleAnnotationDescriptor extends Descriptor<ConsoleNote<?>> implements ExtensionPoint
ConsoleNote
.Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
ExtensionPoint.LegacyInstancesAreScopedToHudson
clazz
Constructor and Description |
---|
ConsoleAnnotationDescriptor() |
ConsoleAnnotationDescriptor(Class<? extends ConsoleNote<?>> clazz) |
Modifier and Type | Method and Description |
---|---|
static DescriptorExtensionList<ConsoleNote<?>,ConsoleAnnotationDescriptor> |
all()
Returns all the registered
ConsoleAnnotationDescriptor descriptors. |
void |
doScriptJs(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp) |
void |
doStyleCss(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp) |
String |
getDisplayName()
Human readable name of this kind of configurable object.
|
boolean |
hasScript()
Returns true if this descriptor has a JavaScript to be inserted on applicable console page.
|
boolean |
hasStylesheet()
Returns true if this descriptor has a stylesheet to be inserted on applicable console page.
|
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
public ConsoleAnnotationDescriptor(Class<? extends ConsoleNote<?>> clazz)
public ConsoleAnnotationDescriptor()
public String getDisplayName()
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
.
Users use this name to enable/disable annotations.getDisplayName
in class Descriptor<ConsoleNote<?>>
public boolean hasScript()
public boolean hasStylesheet()
@WebMethod(name="script.js") public void doScriptJs(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
@WebMethod(name="style.css") public void doStyleCss(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
public static DescriptorExtensionList<ConsoleNote<?>,ConsoleAnnotationDescriptor> all()
ConsoleAnnotationDescriptor
descriptors.Copyright © 2018. All rights reserved.