Package io.jenkins.plugins.designlibrary

Class JavaScriptProxy

java.lang.Object

io.jenkins.plugins.designlibrary.UISample

io.jenkins.plugins.designlibrary.JavaScriptProxy

All Implemented Interfaces:

ExtensionPoint, Action, Describable<UISample>, ModelObject

@Extension
public class JavaScriptProxy
extends UISample

"Export" Java objects to JavaScript in the browser as a proxy object, so that you can make ajax-calls to the server later.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JavaScriptProxy.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
JavaScriptProxy()

Method Summary

Modifier and Type	Method	Description
Category	getCategory()	Retrieves the category of this UI sample.
String	getDescription()	Provides a description for the UI sample.
String	getDisplayName()	Gets the default display name for the UI sample.
String	getIconFileName()
int	increment(int n)	The annotation exposes this method to JavaScript proxy.

Methods inherited from class io.jenkins.plugins.designlibrary.UISample

getAll, getDescriptor, getGrouped, getNextPage, getPreviousPage, getPrismConfiguration, getSince, getUrlName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JavaScriptProxy

public JavaScriptProxy()

Method Details

getIconFileName

public String getIconFileName()

getDisplayName

@NonNull
public String getDisplayName()

Description copied from class: UISample

Gets the default display name for the UI sample. This is typically the simple class name of the implementing class.

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

Overrides:

getDisplayName in class UISample

Returns:

the display name.

getDescription

public String getDescription()

Description copied from class: UISample

Provides a description for the UI sample. The description is displayed at the top of every UI page for the sample.

Specified by:

getDescription in class UISample

Returns:

the description of the UI sample.

getCategory

public Category getCategory()

Description copied from class: UISample

Retrieves the category of this UI sample. Defaults to Category.COMPONENT.

Overrides:

getCategory in class UISample

Returns:

the category of the UI sample.

increment

@JavaScriptMethod
public int increment(int n)

The annotation exposes this method to JavaScript proxy.