Package jetbrains.buildServer.controllers.popupDialogs

Class PopupDialogType<Form_T>

java.lang.Object

jetbrains.buildServer.controllers.popupDialogs.PopupDialogType<Form_T>

All Implemented Interfaces:

ServerExtension, TeamCityExtension

Direct Known Subclasses:

CheckListPopupDialogType

public abstract class PopupDialogType<Form_T>
extends Object
implements ServerExtension

This service determines the behaviour of certain type of popup-dialogs.

To add your own popup-dialog type you must implement this interface and register your implementation as TeamCity extension (via Spring or ExtensionHolder).

To show your popup in web, all you need to do is to call "BS.PopupDialog.show" function with the following params:

• nearestElement - the element near which popup will be shown
• popupDialogTypeId - your popup-dialog type id
• contextParams - parameters those determine the current popup context (in URL params format, like "a=1&b=2&c=3")
• afterApply - optional function that is called after pressing "Apply" button and successful applying of your changes
• moreOptions - additional options for popup presentation, see "BS.Popup" for details

Author:

Maxim.Manuylov Date: 11/7/11

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PopupDialogType(String typeId, String jspPagePath, Class<Form_T> formClass)

Method Summary

Modifier and Type	Method	Description
abstract Form_T	createForm(javax.servlet.http.HttpServletRequest request)
abstract void	fillModel(Map<String,Object> model, Form_T form)
List<PopupDialogAction<Form_T>>	getActions()
Class<Form_T>	getFormClass()
String	getJspPagePath()
String	getTypeId()
protected void	registerAction(PopupDialogAction<Form_T> action)

Methods inherited from class java.lang.Object

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

Constructor Detail

PopupDialogType

protected PopupDialogType(@NotNull @NonNls
                          String typeId,
                          @NotNull @NonNls
                          String jspPagePath,
                          @NotNull
                          Class<Form_T> formClass)

Method Detail

getTypeId

@NotNull
public String getTypeId()

getJspPagePath

@NotNull
public String getJspPagePath()

getFormClass

@NotNull
public Class<Form_T> getFormClass()

createForm

@NotNull
public abstract Form_T createForm(@NotNull
                                  javax.servlet.http.HttpServletRequest request)

fillModel

public abstract void fillModel(@NotNull
                               Map<String,Object> model,
                               @NotNull
                               Form_T form)

getActions

@NotNull
public List<PopupDialogAction<Form_T>> getActions()

registerAction

protected void registerAction(@NotNull
                              PopupDialogAction<Form_T> action)