Interface ParameterRenderContext
-
- All Superinterfaces:
ParameterContext
- All Known Implementing Classes:
ParametersViewBean.RenderContext
public interface ParameterRenderContext extends ParameterContext
Context for parameters control rendering. Control may have a javascript side implementation of control. A control must be registered with a global FQN fuction of 1 parameter. The name of the function to register implementation is sent to the control in#getAdditionalParameters()
. Use this constant as the key.
For more details for javascript object, see BS.CustromControl.AbstractControl.
To get the value useAdditionalParameter#getValue(ParameterRenderContext)
To ease implementation of JS handlers, use ext:registerTypedParameterScript custom tag and estension object into it's body:<ext:registerTypedParameterScript>{ put handler implementation here }</ext:registerTypedParameterScript>
For documentation of functions that may be implemented by the constrol see customControl.js- Since:
- 7.0
- Author:
- Eugene Petrenko (eugene.petrenko@gmail.com) Date: 08.09.11 12:28
-
-
Field Summary
-
Fields inherited from interface jetbrains.buildServer.controllers.parameters.ParameterContext
BUILD_TEMPLATE, BUILD_TYPE, PROJECT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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 interface jetbrains.buildServer.controllers.parameters.ParameterContext
getAdditionalParameter, getDescription
-
-
-
-
Method Detail
-
getParameter
@NotNull Parameter getParameter()
Control should be shown for the given parameter. Implementation must use this interface to obtain parameter value- Returns:
- Parameter instance to show
- Since:
- 7.0
-
getId
@NotNull String getId()
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- Returns:
- Control HTML element ID to be used
- Since:
- 7.0
-
isReadOnly
boolean isReadOnly()
-
-