Package jetbrains.buildServer.controllers.parameters.embed

Class ParametersViewBean.RenderContext

java.lang.Object

jetbrains.buildServer.controllers.parameters.embed.ParametersViewBean.RenderContext

All Implemented Interfaces:

ParameterContext, ParameterRenderContext

Enclosing class:

ParametersViewBean

public class ParametersViewBean.RenderContext
extends Object
implements ParameterRenderContext

Field Summary

Fields inherited from interface jetbrains.buildServer.controllers.parameters.ParameterContext

BUILD_TEMPLATE, BUILD_TYPE, PROJECT

Constructor Summary

Constructors

Constructor	Description
RenderContext(String id, Parameter parameter)

Method Summary

Modifier and Type	Method	Description
<T> T	getAdditionalParameter(AdditionalParameter<T> parameter)	Returns parameter by given key
ControlDescription	getDescription()	Control description to be used for parameter presentation
String	getId()	Constrol must add an HTML input control with given ID.
Parameter	getParameter()	Control should be shown for the given parameter.
boolean	isReadOnly()

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderContext

public RenderContext(@NotNull
                     String id,
                     @NotNull
                     Parameter parameter)

Method Detail

getParameter

@NotNull
public Parameter getParameter()

Description copied from interface: ParameterRenderContext

Control should be shown for the given parameter. Implementation must use this interface to obtain parameter value

Specified by:

getParameter in interface ParameterRenderContext

Returns:

Parameter instance to show

getId

@NotNull
public String getId()

Description copied from interface: ParameterRenderContext

Constrol must add an HTML input control with given ID. This control may have input control of the same name. Host will use this the id to persist form and/or to get value from the control

Specified by:

getId in interface ParameterRenderContext

Returns:

Control HTML element ID to be used

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface ParameterRenderContext

getDescription

@NotNull
public ControlDescription getDescription()

Description copied from interface: ParameterContext

Control description to be used for parameter presentation

Specified by:

getDescription in interface ParameterContext

Returns:

descriptoin of control presentation

getAdditionalParameter

@Nullable
public <T> T getAdditionalParameter(@NotNull
                                    AdditionalParameter<T> parameter)

Description copied from interface: ParameterContext

Returns parameter by given key

Specified by:

getAdditionalParameter in interface ParameterContext

Type Parameters:

T - type of parameter

Parameters:

parameter - key and type of parameter to get

Returns:

parameter or null