Class ConsoleAnnotationDescriptor

    • Constructor Detail

      • ConsoleAnnotationDescriptor

        protected ConsoleAnnotationDescriptor​(Class<? extends ConsoleNote<?>> clazz)
      • ConsoleAnnotationDescriptor

        protected ConsoleAnnotationDescriptor()
    • Method Detail

      • getDisplayName

        @NonNull
        public String getDisplayName()
        Human readable name of this kind of configurable object. Should be overridden for most descriptors, if the display name is visible somehow. As a fallback it uses 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.
        Overrides:
        getDisplayName in class Descriptor<ConsoleNote<?>>
      • hasScript

        public boolean hasScript()
        Returns true if this descriptor has a JavaScript to be inserted on applicable console page.
      • hasStylesheet

        public boolean hasStylesheet()
        Returns true if this descriptor has a stylesheet to be inserted on applicable console page.
      • doScriptJs

        @WebMethod(name="script.js")
        public void doScriptJs​(org.kohsuke.stapler.StaplerRequest req,
                               org.kohsuke.stapler.StaplerResponse rsp)
                        throws IOException,
                               javax.servlet.ServletException
        Throws:
        IOException
        javax.servlet.ServletException
      • doStyleCss

        @WebMethod(name="style.css")
        public void doStyleCss​(org.kohsuke.stapler.StaplerRequest req,
                               org.kohsuke.stapler.StaplerResponse rsp)
                        throws IOException,
                               javax.servlet.ServletException
        Throws:
        IOException
        javax.servlet.ServletException