Package lib

Interface FormTagLib

All Superinterfaces:
groovy.lang.GroovyObject, org.kohsuke.stapler.jelly.groovy.TypedTagLibrary
@TagLibraryUri("/lib/form") public interface FormTagLib extends org.kohsuke.stapler.jelly.groovy.TypedTagLibrary

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    advanced()
    Expandable section that shows "advanced..." button by default.
    void
    advanced(groovy.lang.Closure body)
    Expandable section that shows "advanced..." button by default.
    void
    advanced(Map args)
    Expandable section that shows "advanced..." button by default.
    void
    advanced(Map args, groovy.lang.Closure body)
    Expandable section that shows "advanced..." button by default.
    void
    apply()
    "Apply" button that submits the form but without a page transition.
    void
    apply(groovy.lang.Closure body)
    "Apply" button that submits the form but without a page transition.
    void
    apply(Map args)
    "Apply" button that submits the form but without a page transition.
    void
    apply(Map args, groovy.lang.Closure body)
    "Apply" button that submits the form but without a page transition.
    void
    block()
    Full-width space in the form table that can be filled with arbitrary HTML.
    void
    block(groovy.lang.Closure body)
    Full-width space in the form table that can be filled with arbitrary HTML.
    void
    block(Map args)
    Full-width space in the form table that can be filled with arbitrary HTML.
    void
    block(Map args, groovy.lang.Closure body)
    Full-width space in the form table that can be filled with arbitrary HTML.
    void
    booleanRadio()
    Binds a boolean field to two radio buttons that say Yes/No OK/Cancel Top/Bottom.
    void
    booleanRadio(groovy.lang.Closure body)
    Binds a boolean field to two radio buttons that say Yes/No OK/Cancel Top/Bottom.
    void
    booleanRadio(Map args)
    Binds a boolean field to two radio buttons that say Yes/No OK/Cancel Top/Bottom.
    void
    booleanRadio(Map args, groovy.lang.Closure body)
    Binds a boolean field to two radio buttons that say Yes/No OK/Cancel Top/Bottom.
    void
    bottomButtonBar()
    Creates a button bar at the bottom of the page for things like "Submit".
    void
    bottomButtonBar(groovy.lang.Closure body)
    Creates a button bar at the bottom of the page for things like "Submit".
    void
    bottomButtonBar(Map args)
    Creates a button bar at the bottom of the page for things like "Submit".
    void
    bottomButtonBar(Map args, groovy.lang.Closure body)
    Creates a button bar at the bottom of the page for things like "Submit".
    void
    breadcrumb_config_outline()
    Adds one more in-page breadcrumb that jumps to sections in the page.
    void
    breadcrumb_config_outline(groovy.lang.Closure body)
    Adds one more in-page breadcrumb that jumps to sections in the page.
    void
    breadcrumb_config_outline(Map args)
    Adds one more in-page breadcrumb that jumps to sections in the page.
    void
    breadcrumb_config_outline(Map args, groovy.lang.Closure body)
    Adds one more in-page breadcrumb that jumps to sections in the page.
    void
    checkbox()
    <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    checkbox(groovy.lang.Closure body)
    <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    checkbox(Map args)
    <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    checkbox(Map args, groovy.lang.Closure body)
    <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    class_entry()
    Invisible <f:entry> type for embedding a descriptor's $class field.
    void
    class_entry(groovy.lang.Closure body)
    Invisible <f:entry> type for embedding a descriptor's $class field.
    void
    class_entry(Map args)
    Invisible <f:entry> type for embedding a descriptor's $class field.
    void
    class_entry(Map args, groovy.lang.Closure body)
    Invisible <f:entry> type for embedding a descriptor's $class field.
    void
    combobox()
    Editable drop-down combo box that supports the data binding and AJAX updates.
    void
    combobox(groovy.lang.Closure body)
    Editable drop-down combo box that supports the data binding and AJAX updates.
    void
    combobox(Map args)
    Editable drop-down combo box that supports the data binding and AJAX updates.
    void
    combobox(Map args, groovy.lang.Closure body)
    Editable drop-down combo box that supports the data binding and AJAX updates.
    void
    description()
    Renders a row that shows description text below an input field.
    void
    description(groovy.lang.Closure body)
    Renders a row that shows description text below an input field.
    void
    description(Map args)
    Renders a row that shows description text below an input field.
    void
    description(Map args, groovy.lang.Closure body)
    Renders a row that shows description text below an input field.
    void
    descriptorList()
    Generate config pages from a list of Descriptors into a section.
    void
    descriptorList(groovy.lang.Closure body)
    Generate config pages from a list of Descriptors into a section.
    void
    descriptorList(Map args)
    Generate config pages from a list of Descriptors into a section.
    void
    descriptorList(Map args, groovy.lang.Closure body)
    Generate config pages from a list of Descriptors into a section.
    void
    descriptorRadioList()
    Generate config pages from a list of Descriptors into a section.
    void
    descriptorRadioList(groovy.lang.Closure body)
    Generate config pages from a list of Descriptors into a section.
    void
    descriptorRadioList(Map args)
    Generate config pages from a list of Descriptors into a section.
    void
    descriptorRadioList(Map args, groovy.lang.Closure body)
    Generate config pages from a list of Descriptors into a section.
    void
    dropdownDescriptorSelector()
    Renders a single <select> control for choosing a Describable.
    void
    dropdownDescriptorSelector(groovy.lang.Closure body)
    Renders a single <select> control for choosing a Describable.
    void
    dropdownDescriptorSelector(Map args)
    Renders a single <select> control for choosing a Describable.
    void
    dropdownDescriptorSelector(Map args, groovy.lang.Closure body)
    Renders a single <select> control for choosing a Describable.
    void
    dropdownList()
    Foldable block expanded when the corresponding item is selected in the drop-down list.
    void
    dropdownList(groovy.lang.Closure body)
    Foldable block expanded when the corresponding item is selected in the drop-down list.
    void
    dropdownList(Map args)
    Foldable block expanded when the corresponding item is selected in the drop-down list.
    void
    dropdownList(Map args, groovy.lang.Closure body)
    Foldable block expanded when the corresponding item is selected in the drop-down list.
    void
    dropdownListBlock()
    Foldable block expanded when the corresponding item is selected in the drop-down list.
    void
    dropdownListBlock(groovy.lang.Closure body)
    Foldable block expanded when the corresponding item is selected in the drop-down list.
    void
    dropdownListBlock(Map args)
    Foldable block expanded when the corresponding item is selected in the drop-down list.
    void
    dropdownListBlock(Map args, groovy.lang.Closure body)
    Foldable block expanded when the corresponding item is selected in the drop-down list.
    void
    editableComboBox()
    Editable drop-down combo box.
    void
    editableComboBox(groovy.lang.Closure body)
    Editable drop-down combo box.
    void
    editableComboBox(Map args)
    Editable drop-down combo box.
    void
    editableComboBox(Map args, groovy.lang.Closure body)
    Editable drop-down combo box.
    void
    editableComboBoxValue()
    Used inside <f:editableComboBox/> to specify one value of a combobox.
    void
    editableComboBoxValue(groovy.lang.Closure body)
    Used inside <f:editableComboBox/> to specify one value of a combobox.
    void
    editableComboBoxValue(Map args)
    Used inside <f:editableComboBox/> to specify one value of a combobox.
    void
    editableComboBoxValue(Map args, groovy.lang.Closure body)
    Used inside <f:editableComboBox/> to specify one value of a combobox.
    void
    entry()
    An entry of the <f:form>, which is one logical row (that consists of several <TR> tags.
    void
    entry(groovy.lang.Closure body)
    An entry of the <f:form>, which is one logical row (that consists of several <TR> tags.
    void
    entry(Map args)
    An entry of the <f:form>, which is one logical row (that consists of several <TR> tags.
    void
    entry(Map args, groovy.lang.Closure body)
    An entry of the <f:form>, which is one logical row (that consists of several <TR> tags.
    void
    enum_()
    Binds an enum field to a <select> element.
    void
    enum_(groovy.lang.Closure body)
    Binds an enum field to a <select> element.
    void
    enum_(Map args)
    Binds an enum field to a <select> element.
    void
    enum_(Map args, groovy.lang.Closure body)
    Binds an enum field to a <select> element.
    void
    enumSet()
    Binds a set of Enum to a list of checkboxes, each with the label taken from enum Enum.toString() Should be used inside an <f:entry field='...'> element.
    void
    enumSet(groovy.lang.Closure body)
    Binds a set of Enum to a list of checkboxes, each with the label taken from enum Enum.toString() Should be used inside an <f:entry field='...'> element.
    void
    enumSet(Map args)
    Binds a set of Enum to a list of checkboxes, each with the label taken from enum Enum.toString() Should be used inside an <f:entry field='...'> element.
    void
    enumSet(Map args, groovy.lang.Closure body)
    Binds a set of Enum to a list of checkboxes, each with the label taken from enum Enum.toString() Should be used inside an <f:entry field='...'> element.
    void
    expandableTextbox()
    A single-line textbox that can be expanded into a multi-line textarea.
    void
    expandableTextbox(groovy.lang.Closure body)
    A single-line textbox that can be expanded into a multi-line textarea.
    void
    expandableTextbox(Map args)
    A single-line textbox that can be expanded into a multi-line textarea.
    void
    expandableTextbox(Map args, groovy.lang.Closure body)
    A single-line textbox that can be expanded into a multi-line textarea.
    void
    file()
    Generates an input field All unknown attributes are passed through to the field.
    void
    file(groovy.lang.Closure body)
    Generates an input field All unknown attributes are passed through to the field.
    void
    file(Map args)
    Generates an input field All unknown attributes are passed through to the field.
    void
    file(Map args, groovy.lang.Closure body)
    Generates an input field All unknown attributes are passed through to the field.
    void
    form()
    Outer-most tag of the entire form taglib, that generates <form> element.
    void
    form(groovy.lang.Closure body)
    Outer-most tag of the entire form taglib, that generates <form> element.
    void
    form(Map args)
    Outer-most tag of the entire form taglib, that generates <form> element.
    void
    form(Map args, groovy.lang.Closure body)
    Outer-most tag of the entire form taglib, that generates <form> element.
    void
    helpArea()
    Place holder to lazy-load help text via AJAX.
    void
    helpArea(groovy.lang.Closure body)
    Place holder to lazy-load help text via AJAX.
    void
    helpArea(Map args)
    Place holder to lazy-load help text via AJAX.
    void
    helpArea(Map args, groovy.lang.Closure body)
    Place holder to lazy-load help text via AJAX.
    void
    helpLink()
    Outputs a help link for a <f:form> item if help is available or a spacer if none is available.
    void
    helpLink(groovy.lang.Closure body)
    Outputs a help link for a <f:form> item if help is available or a spacer if none is available.
    void
    helpLink(Map args)
    Outputs a help link for a <f:form> item if help is available or a spacer if none is available.
    void
    helpLink(Map args, groovy.lang.Closure body)
    Outputs a help link for a <f:form> item if help is available or a spacer if none is available.
    void
    hetero_list()
    Outer most tag for creating a heterogeneous list, where the user can choose arbitrary number of arbitrary items from the given list of descriptors, and configure them independently.
    void
    hetero_list(groovy.lang.Closure body)
    Outer most tag for creating a heterogeneous list, where the user can choose arbitrary number of arbitrary items from the given list of descriptors, and configure them independently.
    void
    hetero_list(Map args)
    Outer most tag for creating a heterogeneous list, where the user can choose arbitrary number of arbitrary items from the given list of descriptors, and configure them independently.
    void
    hetero_list(Map args, groovy.lang.Closure body)
    Outer most tag for creating a heterogeneous list, where the user can choose arbitrary number of arbitrary items from the given list of descriptors, and configure them independently.
    void
    hetero_radio()
    Sibling of hetero-list, which only allows the user to pick one type from the list of descriptors and configure it.
    void
    hetero_radio(groovy.lang.Closure body)
    Sibling of hetero-list, which only allows the user to pick one type from the list of descriptors and configure it.
    void
    hetero_radio(Map args)
    Sibling of hetero-list, which only allows the user to pick one type from the list of descriptors and configure it.
    void
    hetero_radio(Map args, groovy.lang.Closure body)
    Sibling of hetero-list, which only allows the user to pick one type from the list of descriptors and configure it.
    void
    invisibleEntry()
    Invisible <f:entry> type.
    void
    invisibleEntry(groovy.lang.Closure body)
    Invisible <f:entry> type.
    void
    invisibleEntry(Map args)
    Invisible <f:entry> type.
    void
    invisibleEntry(Map args, groovy.lang.Closure body)
    Invisible <f:entry> type.
    void
    link()
    Generates an anchor element with the ability to send POST requests.
    void
    link(groovy.lang.Closure body)
    Generates an anchor element with the ability to send POST requests.
    void
    link(Map args)
    Generates an anchor element with the ability to send POST requests.
    void
    link(Map args, groovy.lang.Closure body)
    Generates an anchor element with the ability to send POST requests.
    void
    nested()
     
    void
    nested(groovy.lang.Closure body)
     
    void
    nested(Map args)
     
    void
    nested(Map args, groovy.lang.Closure body)
     
    void
    number()
    Generates an input field to be used inside <f:entry/>
    void
    number(groovy.lang.Closure body)
    Generates an input field to be used inside <f:entry/>
    void
    number(Map args)
    Generates an input field to be used inside <f:entry/>
    void
    number(Map args, groovy.lang.Closure body)
    Generates an input field to be used inside <f:entry/>
    void
    option()
    <option> tag for the <select> element that takes true/false for selected.
    void
    option(groovy.lang.Closure body)
    <option> tag for the <select> element that takes true/false for selected.
    void
    option(Map args)
    <option> tag for the <select> element that takes true/false for selected.
    void
    option(Map args, groovy.lang.Closure body)
    <option> tag for the <select> element that takes true/false for selected.
    void
    optionalBlock()
    Foldable block that can be expanded to show more controls by checking the checkbox.
    void
    optionalBlock(groovy.lang.Closure body)
    Foldable block that can be expanded to show more controls by checking the checkbox.
    void
    optionalBlock(Map args)
    Foldable block that can be expanded to show more controls by checking the checkbox.
    void
    optionalBlock(Map args, groovy.lang.Closure body)
    Foldable block that can be expanded to show more controls by checking the checkbox.
    void
    optionalProperty()
    Renders inline an optional single-value nested data-bound property of the current instance, by using a <f:optionalBlock> This is useful when your object composes another data-bound object, and when that's optional, where the absence of the value is signified as null (in which case the optionalBlock will be drawn unchecked), and the presence of the value.
    void
    optionalProperty(groovy.lang.Closure body)
    Renders inline an optional single-value nested data-bound property of the current instance, by using a <f:optionalBlock> This is useful when your object composes another data-bound object, and when that's optional, where the absence of the value is signified as null (in which case the optionalBlock will be drawn unchecked), and the presence of the value.
    void
    optionalProperty(Map args)
    Renders inline an optional single-value nested data-bound property of the current instance, by using a <f:optionalBlock> This is useful when your object composes another data-bound object, and when that's optional, where the absence of the value is signified as null (in which case the optionalBlock will be drawn unchecked), and the presence of the value.
    void
    optionalProperty(Map args, groovy.lang.Closure body)
    Renders inline an optional single-value nested data-bound property of the current instance, by using a <f:optionalBlock> This is useful when your object composes another data-bound object, and when that's optional, where the absence of the value is signified as null (in which case the optionalBlock will be drawn unchecked), and the presence of the value.
    void
    password()
    Glorified <input type="password">
    void
    password(groovy.lang.Closure body)
    Glorified <input type="password">
    void
    password(Map args)
    Glorified <input type="password">
    void
    password(Map args, groovy.lang.Closure body)
    Glorified <input type="password">
    void
    possibleReadOnlyField()
     
    void
    possibleReadOnlyField(groovy.lang.Closure body)
     
    void
    possibleReadOnlyField(Map args)
     
    void
    possibleReadOnlyField(Map args, groovy.lang.Closure body)
     
    void
    prepareDatabinding()
    Modifies the 'attrs.field' of the parent to inherit @field from the enclosing <f:entry> if available.
    void
    prepareDatabinding(groovy.lang.Closure body)
    Modifies the 'attrs.field' of the parent to inherit @field from the enclosing <f:entry> if available.
    void
    prepareDatabinding(Map args)
    Modifies the 'attrs.field' of the parent to inherit @field from the enclosing <f:entry> if available.
    void
    prepareDatabinding(Map args, groovy.lang.Closure body)
    Modifies the 'attrs.field' of the parent to inherit @field from the enclosing <f:entry> if available.
    void
    property()
    Renders inline a single-value nested data-bound property of the current instance.
    void
    property(groovy.lang.Closure body)
    Renders inline a single-value nested data-bound property of the current instance.
    void
    property(Map args)
    Renders inline a single-value nested data-bound property of the current instance.
    void
    property(Map args, groovy.lang.Closure body)
    Renders inline a single-value nested data-bound property of the current instance.
    void
    radio()
    <input type="radio"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    radio(groovy.lang.Closure body)
    <input type="radio"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    radio(Map args)
    <input type="radio"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    radio(Map args, groovy.lang.Closure body)
    <input type="radio"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    radioBlock()
    Radio button with a label that hides additional controls.
    void
    radioBlock(groovy.lang.Closure body)
    Radio button with a label that hides additional controls.
    void
    radioBlock(Map args)
    Radio button with a label that hides additional controls.
    void
    radioBlock(Map args, groovy.lang.Closure body)
    Radio button with a label that hides additional controls.
    void
    readOnlyTextbox()
    Generates an input field to be used inside <f:entry/>
    void
    readOnlyTextbox(groovy.lang.Closure body)
    Generates an input field to be used inside <f:entry/>
    void
    readOnlyTextbox(Map args)
    Generates an input field to be used inside <f:entry/>
    void
    readOnlyTextbox(Map args, groovy.lang.Closure body)
    Generates an input field to be used inside <f:entry/>
    void
    repeatable()
    Repeatable blocks used to present UI where the user can configure multiple entries of the same kind (see the Java installations configuration in the system config.) This tag works like <j:forEach> and repeatedly evaluate the body so that initially all the items get their own copy.
    void
    repeatable(groovy.lang.Closure body)
    Repeatable blocks used to present UI where the user can configure multiple entries of the same kind (see the Java installations configuration in the system config.) This tag works like <j:forEach> and repeatedly evaluate the body so that initially all the items get their own copy.
    void
    repeatable(Map args)
    Repeatable blocks used to present UI where the user can configure multiple entries of the same kind (see the Java installations configuration in the system config.) This tag works like <j:forEach> and repeatedly evaluate the body so that initially all the items get their own copy.
    void
    repeatable(Map args, groovy.lang.Closure body)
    Repeatable blocks used to present UI where the user can configure multiple entries of the same kind (see the Java installations configuration in the system config.) This tag works like <j:forEach> and repeatedly evaluate the body so that initially all the items get their own copy.
    void
    repeatableDeleteButton()
    Delete button for the <repeatable> tag.
    void
    repeatableDeleteButton(groovy.lang.Closure body)
    Delete button for the <repeatable> tag.
    void
    repeatableDeleteButton(Map args)
    Delete button for the <repeatable> tag.
    void
    repeatableDeleteButton(Map args, groovy.lang.Closure body)
    Delete button for the <repeatable> tag.
    void
    repeatableHeteroProperty()
    Data-bound only version of <f:hetero-list> that assumes the type pointed by the property is data-bound as well.
    void
    repeatableHeteroProperty(groovy.lang.Closure body)
    Data-bound only version of <f:hetero-list> that assumes the type pointed by the property is data-bound as well.
    void
    repeatableHeteroProperty(Map args)
    Data-bound only version of <f:hetero-list> that assumes the type pointed by the property is data-bound as well.
    void
    repeatableHeteroProperty(Map args, groovy.lang.Closure body)
    Data-bound only version of <f:hetero-list> that assumes the type pointed by the property is data-bound as well.
    void
    repeatableProperty()
    Data-bound only version of <f:repeatable> that assumes the type pointed by the property is data-bound as well.
    void
    repeatableProperty(groovy.lang.Closure body)
    Data-bound only version of <f:repeatable> that assumes the type pointed by the property is data-bound as well.
    void
    repeatableProperty(Map args)
    Data-bound only version of <f:repeatable> that assumes the type pointed by the property is data-bound as well.
    void
    repeatableProperty(Map args, groovy.lang.Closure body)
    Data-bound only version of <f:repeatable> that assumes the type pointed by the property is data-bound as well.
    void
    rowSet()
    Adds @nameRef to all table rows inside this tag, so that when the form is submitted, it gets grouped in one JSON object.
    void
    rowSet(groovy.lang.Closure body)
    Adds @nameRef to all table rows inside this tag, so that when the form is submitted, it gets grouped in one JSON object.
    void
    rowSet(Map args)
    Adds @nameRef to all table rows inside this tag, so that when the form is submitted, it gets grouped in one JSON object.
    void
    rowSet(Map args, groovy.lang.Closure body)
    Adds @nameRef to all table rows inside this tag, so that when the form is submitted, it gets grouped in one JSON object.
    void
    secretTextarea()
    Enhanced version of <f:textarea/> for editing multi-line secrets.
    void
    secretTextarea(groovy.lang.Closure body)
    Enhanced version of <f:textarea/> for editing multi-line secrets.
    void
    secretTextarea(Map args)
    Enhanced version of <f:textarea/> for editing multi-line secrets.
    void
    secretTextarea(Map args, groovy.lang.Closure body)
    Enhanced version of <f:textarea/> for editing multi-line secrets.
    void
    section()
    Section header in the form table.
    void
    section(groovy.lang.Closure body)
    Section header in the form table.
    void
    section(Map args)
    Section header in the form table.
    void
    section(Map args, groovy.lang.Closure body)
    Section header in the form table.
    void
    select()
    Glorified <select> control that supports the data binding and AJAX updates.
    void
    select(groovy.lang.Closure body)
    Glorified <select> control that supports the data binding and AJAX updates.
    void
    select(Map args)
    Glorified <select> control that supports the data binding and AJAX updates.
    void
    select(Map args, groovy.lang.Closure body)
    Glorified <select> control that supports the data binding and AJAX updates.
    void
    slave_mode()
    A listbox for choosing the agent's usage.
    void
    slave_mode(groovy.lang.Closure body)
    A listbox for choosing the agent's usage.
    void
    slave_mode(Map args)
    A listbox for choosing the agent's usage.
    void
    slave_mode(Map args, groovy.lang.Closure body)
    A listbox for choosing the agent's usage.
    void
    submit()
    Submit button.
    void
    submit(groovy.lang.Closure body)
    Submit button.
    void
    submit(Map args)
    Submit button.
    void
    submit(Map args, groovy.lang.Closure body)
    Submit button.
    void
    textarea()
    <textarea> tag on steroids.
    void
    textarea(groovy.lang.Closure body)
    <textarea> tag on steroids.
    void
    textarea(Map args)
    <textarea> tag on steroids.
    void
    textarea(Map args, groovy.lang.Closure body)
    <textarea> tag on steroids.
    void
    textbox()
    Generates an input field to be used inside <f:entry/> For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support
    void
    textbox(groovy.lang.Closure body)
    Generates an input field to be used inside <f:entry/> For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support
    void
    textbox(Map args)
    Generates an input field to be used inside <f:entry/> For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support
    void
    textbox(Map args, groovy.lang.Closure body)
    Generates an input field to be used inside <f:entry/> For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support
    void
    toggleSwitch()
    <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    toggleSwitch(groovy.lang.Closure body)
    <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    toggleSwitch(Map args)
    <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    toggleSwitch(Map args, groovy.lang.Closure body)
    <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.
    void
    validateButton()
    See https://www.jenkins.io/doc/developer/forms/jelly-form-controls/ for the reference.
    void
    validateButton(groovy.lang.Closure body)
    See https://www.jenkins.io/doc/developer/forms/jelly-form-controls/ for the reference.
    void
    validateButton(Map args)
    See https://www.jenkins.io/doc/developer/forms/jelly-form-controls/ for the reference.
    void
    validateButton(Map args, groovy.lang.Closure body)
    See https://www.jenkins.io/doc/developer/forms/jelly-form-controls/ for the reference.
    void
    withCustomDescriptorByName()
    Execute the body with a temporary currentDescriptorByNameUrl value
    void
    withCustomDescriptorByName(groovy.lang.Closure body)
    Execute the body with a temporary currentDescriptorByNameUrl value
    void
    withCustomDescriptorByName(Map args)
    Execute the body with a temporary currentDescriptorByNameUrl value
    void
    withCustomDescriptorByName(Map args, groovy.lang.Closure body)
    Execute the body with a temporary currentDescriptorByNameUrl value

    Methods inherited from interface groovy.lang.GroovyObject

    getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty

  • Method Details

    • description

      void description(Map args, groovy.lang.Closure body)
      Renders a row that shows description text below an input field.

    • description

      void description(groovy.lang.Closure body)
      Renders a row that shows description text below an input field.

    • description

      void description(Map args)
      Renders a row that shows description text below an input field.

    • description

      void description()
      Renders a row that shows description text below an input field.

    • nested

      void nested(Map args, groovy.lang.Closure body)

    • nested

      void nested(groovy.lang.Closure body)

    • nested

      void nested(Map args)

    • nested

      void nested()

    • invisibleEntry

      void invisibleEntry(Map args, groovy.lang.Closure body)
      Invisible <f:entry> type. Useful for adding hidden field values.

    • invisibleEntry

      void invisibleEntry(groovy.lang.Closure body)
      Invisible <f:entry> type. Useful for adding hidden field values.

    • invisibleEntry

      void invisibleEntry(Map args)
      Invisible <f:entry> type. Useful for adding hidden field values.

    • invisibleEntry

      void invisibleEntry()
      Invisible <f:entry> type. Useful for adding hidden field values.

    • submit

      void submit(Map args, groovy.lang.Closure body)
      Submit button. This should be always used instead of the plain <button> tag.

    • submit

      void submit(groovy.lang.Closure body)
      Submit button. This should be always used instead of the plain <button> tag.

    • submit

      void submit(Map args)
      Submit button. This should be always used instead of the plain <button> tag.

    • submit

      void submit()
      Submit button. This should be always used instead of the plain <button> tag.

    • file

      void file(Map args, groovy.lang.Closure body)
      Generates an input field All unknown attributes are passed through to the field.
      Since:
      2.385

    • file

      void file(groovy.lang.Closure body)
      Generates an input field All unknown attributes are passed through to the field.
      Since:
      2.385

    • file

      void file(Map args)
      Generates an input field All unknown attributes are passed through to the field.
      Since:
      2.385

    • file

      void file()
      Generates an input field All unknown attributes are passed through to the field.
      Since:
      2.385

    • form

      void form(Map args, groovy.lang.Closure body)
      Outer-most tag of the entire form taglib, that generates <form> element.

    • form

      void form(groovy.lang.Closure body)
      Outer-most tag of the entire form taglib, that generates <form> element.

    • form

      void form(Map args)
      Outer-most tag of the entire form taglib, that generates <form> element.

    • form

      void form()
      Outer-most tag of the entire form taglib, that generates <form> element.

    • optionalBlock

      void optionalBlock(Map args, groovy.lang.Closure body)
      Foldable block that can be expanded to show more controls by checking the checkbox.

    • optionalBlock

      void optionalBlock(groovy.lang.Closure body)
      Foldable block that can be expanded to show more controls by checking the checkbox.

    • optionalBlock

      void optionalBlock(Map args)
      Foldable block that can be expanded to show more controls by checking the checkbox.

    • optionalBlock

      void optionalBlock()
      Foldable block that can be expanded to show more controls by checking the checkbox.

    • editableComboBox

      void editableComboBox(Map args, groovy.lang.Closure body)
      Editable drop-down combo box. Deprecated as of 1.356. Use f:combobox and databinding instead.

    • editableComboBox

      void editableComboBox(groovy.lang.Closure body)
      Editable drop-down combo box. Deprecated as of 1.356. Use f:combobox and databinding instead.

    • editableComboBox

      void editableComboBox(Map args)
      Editable drop-down combo box. Deprecated as of 1.356. Use f:combobox and databinding instead.

    • editableComboBox

      void editableComboBox()
      Editable drop-down combo box. Deprecated as of 1.356. Use f:combobox and databinding instead.

    • rowSet

      void rowSet(Map args, groovy.lang.Closure body)
      Adds @nameRef to all table rows inside this tag, so that when the form is submitted, it gets grouped in one JSON object.

    • rowSet

      void rowSet(groovy.lang.Closure body)
      Adds @nameRef to all table rows inside this tag, so that when the form is submitted, it gets grouped in one JSON object.

    • rowSet

      void rowSet(Map args)
      Adds @nameRef to all table rows inside this tag, so that when the form is submitted, it gets grouped in one JSON object.

    • rowSet

      void rowSet()
      Adds @nameRef to all table rows inside this tag, so that when the form is submitted, it gets grouped in one JSON object.

    • class_entry

      @TagFile("class-entry") void class_entry(Map args, groovy.lang.Closure body)
      Invisible <f:entry> type for embedding a descriptor's $class field. Most of the time a Descriptor has an unique class name that we can use to instantiate the right Describable class, so we use the '$class' to represent that to clarify the intent. In some other times, such as templates, there are multiple Descriptors with the same Descriptor.clazz but different IDs, and in that case we put 'kind' to indicate that. In this case, to avoid confusing readers we do not put non-unique '$class'. See Descriptor.newInstancesFromHeteroList for how the reader side is handled.

    • class_entry

      @TagFile("class-entry") void class_entry(groovy.lang.Closure body)
      Invisible <f:entry> type for embedding a descriptor's $class field. Most of the time a Descriptor has an unique class name that we can use to instantiate the right Describable class, so we use the '$class' to represent that to clarify the intent. In some other times, such as templates, there are multiple Descriptors with the same Descriptor.clazz but different IDs, and in that case we put 'kind' to indicate that. In this case, to avoid confusing readers we do not put non-unique '$class'. See Descriptor.newInstancesFromHeteroList for how the reader side is handled.

    • class_entry

      @TagFile("class-entry") void class_entry(Map args)
      Invisible <f:entry> type for embedding a descriptor's $class field. Most of the time a Descriptor has an unique class name that we can use to instantiate the right Describable class, so we use the '$class' to represent that to clarify the intent. In some other times, such as templates, there are multiple Descriptors with the same Descriptor.clazz but different IDs, and in that case we put 'kind' to indicate that. In this case, to avoid confusing readers we do not put non-unique '$class'. See Descriptor.newInstancesFromHeteroList for how the reader side is handled.

    • class_entry

      @TagFile("class-entry") void class_entry()
      Invisible <f:entry> type for embedding a descriptor's $class field. Most of the time a Descriptor has an unique class name that we can use to instantiate the right Describable class, so we use the '$class' to represent that to clarify the intent. In some other times, such as templates, there are multiple Descriptors with the same Descriptor.clazz but different IDs, and in that case we put 'kind' to indicate that. In this case, to avoid confusing readers we do not put non-unique '$class'. See Descriptor.newInstancesFromHeteroList for how the reader side is handled.

    • section

      void section(Map args, groovy.lang.Closure body)
      Section header in the form table.

    • section

      void section(groovy.lang.Closure body)
      Section header in the form table.

    • section

      void section(Map args)
      Section header in the form table.

    • section

      void section()
      Section header in the form table.

    • editableComboBoxValue

      void editableComboBoxValue(Map args, groovy.lang.Closure body)
      Used inside <f:editableComboBox/> to specify one value of a combobox. Normally one would use multiple values.

    • editableComboBoxValue

      void editableComboBoxValue(groovy.lang.Closure body)
      Used inside <f:editableComboBox/> to specify one value of a combobox. Normally one would use multiple values.

    • editableComboBoxValue

      void editableComboBoxValue(Map args)
      Used inside <f:editableComboBox/> to specify one value of a combobox. Normally one would use multiple values.

    • editableComboBoxValue

      void editableComboBoxValue()
      Used inside <f:editableComboBox/> to specify one value of a combobox. Normally one would use multiple values.

    • block

      void block(Map args, groovy.lang.Closure body)
      Full-width space in the form table that can be filled with arbitrary HTML.

    • block

      void block(groovy.lang.Closure body)
      Full-width space in the form table that can be filled with arbitrary HTML.

    • block

      void block(Map args)
      Full-width space in the form table that can be filled with arbitrary HTML.

    • block

      void block()
      Full-width space in the form table that can be filled with arbitrary HTML.

    • property

      void property(Map args, groovy.lang.Closure body)
      Renders inline a single-value nested data-bound property of the current instance. This is useful when your object composes another data-bound object as a nested object, yet your UI would still like to render it

    • property

      void property(groovy.lang.Closure body)
      Renders inline a single-value nested data-bound property of the current instance. This is useful when your object composes another data-bound object as a nested object, yet your UI would still like to render it

    • property

      void property(Map args)
      Renders inline a single-value nested data-bound property of the current instance. This is useful when your object composes another data-bound object as a nested object, yet your UI would still like to render it

    • property

      void property()
      Renders inline a single-value nested data-bound property of the current instance. This is useful when your object composes another data-bound object as a nested object, yet your UI would still like to render it

    • expandableTextbox

      void expandableTextbox(Map args, groovy.lang.Closure body)
      A single-line textbox that can be expanded into a multi-line textarea. This control is useful for a field that expects multiple whitespace-separated tokens (such as URLs, glob patterns, etc.) When the user only enters a few tokens, they can keep it as a single line to save space, but to enter a large number of values, this can be turned into textarea for better visibility. If the initial value is already multi-line text, the control starts with textarea. On the server side, your program is responsible for treating ' ', \t, \r, and \n for separators. (StringTokenizer would do this.)

    • expandableTextbox

      void expandableTextbox(groovy.lang.Closure body)
      A single-line textbox that can be expanded into a multi-line textarea. This control is useful for a field that expects multiple whitespace-separated tokens (such as URLs, glob patterns, etc.) When the user only enters a few tokens, they can keep it as a single line to save space, but to enter a large number of values, this can be turned into textarea for better visibility. If the initial value is already multi-line text, the control starts with textarea. On the server side, your program is responsible for treating ' ', \t, \r, and \n for separators. (StringTokenizer would do this.)

    • expandableTextbox

      void expandableTextbox(Map args)
      A single-line textbox that can be expanded into a multi-line textarea. This control is useful for a field that expects multiple whitespace-separated tokens (such as URLs, glob patterns, etc.) When the user only enters a few tokens, they can keep it as a single line to save space, but to enter a large number of values, this can be turned into textarea for better visibility. If the initial value is already multi-line text, the control starts with textarea. On the server side, your program is responsible for treating ' ', \t, \r, and \n for separators. (StringTokenizer would do this.)

    • expandableTextbox

      void expandableTextbox()
      A single-line textbox that can be expanded into a multi-line textarea. This control is useful for a field that expects multiple whitespace-separated tokens (such as URLs, glob patterns, etc.) When the user only enters a few tokens, they can keep it as a single line to save space, but to enter a large number of values, this can be turned into textarea for better visibility. If the initial value is already multi-line text, the control starts with textarea. On the server side, your program is responsible for treating ' ', \t, \r, and \n for separators. (StringTokenizer would do this.)

    • option

      void option(Map args, groovy.lang.Closure body)
      <option> tag for the <select> element that takes true/false for selected.

    • option

      void option(groovy.lang.Closure body)
      <option> tag for the <select> element that takes true/false for selected.

    • option

      void option(Map args)
      <option> tag for the <select> element that takes true/false for selected.

    • option

      void option()
      <option> tag for the <select> element that takes true/false for selected.

    • number

      void number(Map args, groovy.lang.Closure body)
      Generates an input field to be used inside <f:entry/>

    • number

      void number(groovy.lang.Closure body)
      Generates an input field to be used inside <f:entry/>

    • number

      void number(Map args)
      Generates an input field to be used inside <f:entry/>

    • number

      void number()
      Generates an input field to be used inside <f:entry/>

    • password

      void password(Map args, groovy.lang.Closure body)
      Glorified <input type="password">

    • password

      void password(groovy.lang.Closure body)
      Glorified <input type="password">

    • password

      void password(Map args)
      Glorified <input type="password">

    • password

      void password()
      Glorified <input type="password">

    • optionalProperty

      void optionalProperty(Map args, groovy.lang.Closure body)
      Renders inline an optional single-value nested data-bound property of the current instance, by using a <f:optionalBlock> This is useful when your object composes another data-bound object, and when that's optional, where the absence of the value is signified as null (in which case the optionalBlock will be drawn unchecked), and the presence of the value.

    • optionalProperty

      void optionalProperty(groovy.lang.Closure body)
      Renders inline an optional single-value nested data-bound property of the current instance, by using a <f:optionalBlock> This is useful when your object composes another data-bound object, and when that's optional, where the absence of the value is signified as null (in which case the optionalBlock will be drawn unchecked), and the presence of the value.

    • optionalProperty

      void optionalProperty(Map args)
      Renders inline an optional single-value nested data-bound property of the current instance, by using a <f:optionalBlock> This is useful when your object composes another data-bound object, and when that's optional, where the absence of the value is signified as null (in which case the optionalBlock will be drawn unchecked), and the presence of the value.

    • optionalProperty

      void optionalProperty()
      Renders inline an optional single-value nested data-bound property of the current instance, by using a <f:optionalBlock> This is useful when your object composes another data-bound object, and when that's optional, where the absence of the value is signified as null (in which case the optionalBlock will be drawn unchecked), and the presence of the value.

    • validateButton

      void validateButton(Map args, groovy.lang.Closure body)
      See https://www.jenkins.io/doc/developer/forms/jelly-form-controls/ for the reference.

    • validateButton

      void validateButton(groovy.lang.Closure body)
      See https://www.jenkins.io/doc/developer/forms/jelly-form-controls/ for the reference.

    • validateButton

      void validateButton(Map args)
      See https://www.jenkins.io/doc/developer/forms/jelly-form-controls/ for the reference.

    • validateButton

      void validateButton()
      See https://www.jenkins.io/doc/developer/forms/jelly-form-controls/ for the reference.

    • hetero_list

      @TagFile("hetero-list") void hetero_list(Map args, groovy.lang.Closure body)
      Outer most tag for creating a heterogeneous list, where the user can choose arbitrary number of arbitrary items from the given list of descriptors, and configure them independently. The submission can be data-bound into List<T> where T is the common base type for the describable instances. For databinding use, please use <f:repeatableHeteroProperty />

    • hetero_list

      @TagFile("hetero-list") void hetero_list(groovy.lang.Closure body)
      Outer most tag for creating a heterogeneous list, where the user can choose arbitrary number of arbitrary items from the given list of descriptors, and configure them independently. The submission can be data-bound into List<T> where T is the common base type for the describable instances. For databinding use, please use <f:repeatableHeteroProperty />

    • hetero_list

      @TagFile("hetero-list") void hetero_list(Map args)
      Outer most tag for creating a heterogeneous list, where the user can choose arbitrary number of arbitrary items from the given list of descriptors, and configure them independently. The submission can be data-bound into List<T> where T is the common base type for the describable instances. For databinding use, please use <f:repeatableHeteroProperty />

    • hetero_list

      @TagFile("hetero-list") void hetero_list()
      Outer most tag for creating a heterogeneous list, where the user can choose arbitrary number of arbitrary items from the given list of descriptors, and configure them independently. The submission can be data-bound into List<T> where T is the common base type for the describable instances. For databinding use, please use <f:repeatableHeteroProperty />

    • possibleReadOnlyField

      void possibleReadOnlyField(Map args, groovy.lang.Closure body)

    • possibleReadOnlyField

      void possibleReadOnlyField(groovy.lang.Closure body)

    • possibleReadOnlyField

      void possibleReadOnlyField(Map args)

    • possibleReadOnlyField

      void possibleReadOnlyField()

    • apply

      void apply(Map args, groovy.lang.Closure body)
      "Apply" button that submits the form but without a page transition. See hudson.util.FormApply for the server-side code. When this button is pressed, the FORM element fires the "jenkins:apply" event that allows interested parties to write back whatever states back into the INPUT elements.

    • apply

      void apply(groovy.lang.Closure body)
      "Apply" button that submits the form but without a page transition. See hudson.util.FormApply for the server-side code. When this button is pressed, the FORM element fires the "jenkins:apply" event that allows interested parties to write back whatever states back into the INPUT elements.

    • apply

      void apply(Map args)
      "Apply" button that submits the form but without a page transition. See hudson.util.FormApply for the server-side code. When this button is pressed, the FORM element fires the "jenkins:apply" event that allows interested parties to write back whatever states back into the INPUT elements.

    • apply

      void apply()
      "Apply" button that submits the form but without a page transition. See hudson.util.FormApply for the server-side code. When this button is pressed, the FORM element fires the "jenkins:apply" event that allows interested parties to write back whatever states back into the INPUT elements.

    • hetero_radio

      @TagFile("hetero-radio") void hetero_radio(Map args, groovy.lang.Closure body)
      Sibling of hetero-list, which only allows the user to pick one type from the list of descriptors and configure it.

    • hetero_radio

      @TagFile("hetero-radio") void hetero_radio(groovy.lang.Closure body)
      Sibling of hetero-list, which only allows the user to pick one type from the list of descriptors and configure it.

    • hetero_radio

      @TagFile("hetero-radio") void hetero_radio(Map args)
      Sibling of hetero-list, which only allows the user to pick one type from the list of descriptors and configure it.

    • hetero_radio

      @TagFile("hetero-radio") void hetero_radio()
      Sibling of hetero-list, which only allows the user to pick one type from the list of descriptors and configure it.

    • repeatableProperty

      void repeatableProperty(Map args, groovy.lang.Closure body)
      Data-bound only version of <f:repeatable> that assumes the type pointed by the property is data-bound as well. The nested property type must be Describable and it needs to have config.jelly. Unless that nested config.jelly already adds a delete button (deprecated), you should normally put the following inside this tag: {noformat} <f:block> <div align="right"> <f:repeatableDeleteButton /> </div> </f:block> {noformat} Due to a bug in Stapler data binding the model elements are only set if they consist of one or more values. If all values have been removed in the user interface (i.e. the associated form is empty), then the setter is not invoked anymore. As a workaround, you need to override the corresponding configure method and clear the model property manually before invoking the data binding. See warnings-ng-plugin PR#266.

    • repeatableProperty

      void repeatableProperty(groovy.lang.Closure body)
      Data-bound only version of <f:repeatable> that assumes the type pointed by the property is data-bound as well. The nested property type must be Describable and it needs to have config.jelly. Unless that nested config.jelly already adds a delete button (deprecated), you should normally put the following inside this tag: {noformat} <f:block> <div align="right"> <f:repeatableDeleteButton /> </div> </f:block> {noformat} Due to a bug in Stapler data binding the model elements are only set if they consist of one or more values. If all values have been removed in the user interface (i.e. the associated form is empty), then the setter is not invoked anymore. As a workaround, you need to override the corresponding configure method and clear the model property manually before invoking the data binding. See warnings-ng-plugin PR#266.

    • repeatableProperty

      void repeatableProperty(Map args)
      Data-bound only version of <f:repeatable> that assumes the type pointed by the property is data-bound as well. The nested property type must be Describable and it needs to have config.jelly. Unless that nested config.jelly already adds a delete button (deprecated), you should normally put the following inside this tag: {noformat} <f:block> <div align="right"> <f:repeatableDeleteButton /> </div> </f:block> {noformat} Due to a bug in Stapler data binding the model elements are only set if they consist of one or more values. If all values have been removed in the user interface (i.e. the associated form is empty), then the setter is not invoked anymore. As a workaround, you need to override the corresponding configure method and clear the model property manually before invoking the data binding. See warnings-ng-plugin PR#266.

    • repeatableProperty

      void repeatableProperty()
      Data-bound only version of <f:repeatable> that assumes the type pointed by the property is data-bound as well. The nested property type must be Describable and it needs to have config.jelly. Unless that nested config.jelly already adds a delete button (deprecated), you should normally put the following inside this tag: {noformat} <f:block> <div align="right"> <f:repeatableDeleteButton /> </div> </f:block> {noformat} Due to a bug in Stapler data binding the model elements are only set if they consist of one or more values. If all values have been removed in the user interface (i.e. the associated form is empty), then the setter is not invoked anymore. As a workaround, you need to override the corresponding configure method and clear the model property manually before invoking the data binding. See warnings-ng-plugin PR#266.

    • combobox

      void combobox(Map args, groovy.lang.Closure body)
      Editable drop-down combo box that supports the data binding and AJAX updates. Your descriptor should have the 'doFillXyzItems' method, which returns a ComboBoxModel representation of the items in your combo box, and your instance field should hold the current value. For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • combobox

      void combobox(groovy.lang.Closure body)
      Editable drop-down combo box that supports the data binding and AJAX updates. Your descriptor should have the 'doFillXyzItems' method, which returns a ComboBoxModel representation of the items in your combo box, and your instance field should hold the current value. For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • combobox

      void combobox(Map args)
      Editable drop-down combo box that supports the data binding and AJAX updates. Your descriptor should have the 'doFillXyzItems' method, which returns a ComboBoxModel representation of the items in your combo box, and your instance field should hold the current value. For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • combobox

      void combobox()
      Editable drop-down combo box that supports the data binding and AJAX updates. Your descriptor should have the 'doFillXyzItems' method, which returns a ComboBoxModel representation of the items in your combo box, and your instance field should hold the current value. For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • bottomButtonBar

      void bottomButtonBar(Map args, groovy.lang.Closure body)
      Creates a button bar at the bottom of the page for things like "Submit". The actual buttons should be specified as the body of this tag. This area will always be visible at the bottom of the screen.

    • bottomButtonBar

      void bottomButtonBar(groovy.lang.Closure body)
      Creates a button bar at the bottom of the page for things like "Submit". The actual buttons should be specified as the body of this tag. This area will always be visible at the bottom of the screen.

    • bottomButtonBar

      void bottomButtonBar(Map args)
      Creates a button bar at the bottom of the page for things like "Submit". The actual buttons should be specified as the body of this tag. This area will always be visible at the bottom of the screen.

    • bottomButtonBar

      void bottomButtonBar()
      Creates a button bar at the bottom of the page for things like "Submit". The actual buttons should be specified as the body of this tag. This area will always be visible at the bottom of the screen.

    • descriptorRadioList

      void descriptorRadioList(Map args, groovy.lang.Closure body)
      Generate config pages from a list of Descriptors into a section.

    • descriptorRadioList

      void descriptorRadioList(groovy.lang.Closure body)
      Generate config pages from a list of Descriptors into a section.

    • descriptorRadioList

      void descriptorRadioList(Map args)
      Generate config pages from a list of Descriptors into a section.

    • descriptorRadioList

      void descriptorRadioList()
      Generate config pages from a list of Descriptors into a section.

    • repeatableHeteroProperty

      void repeatableHeteroProperty(Map args, groovy.lang.Closure body)
      Data-bound only version of <f:hetero-list> that assumes the type pointed by the property is data-bound as well. The nested property type must be Describable and it needs to have config.jelly.

    • repeatableHeteroProperty

      void repeatableHeteroProperty(groovy.lang.Closure body)
      Data-bound only version of <f:hetero-list> that assumes the type pointed by the property is data-bound as well. The nested property type must be Describable and it needs to have config.jelly.

    • repeatableHeteroProperty

      void repeatableHeteroProperty(Map args)
      Data-bound only version of <f:hetero-list> that assumes the type pointed by the property is data-bound as well. The nested property type must be Describable and it needs to have config.jelly.

    • repeatableHeteroProperty

      void repeatableHeteroProperty()
      Data-bound only version of <f:hetero-list> that assumes the type pointed by the property is data-bound as well. The nested property type must be Describable and it needs to have config.jelly.

    • secretTextarea

      void secretTextarea(Map args, groovy.lang.Closure body)
      Enhanced version of <f:textarea/> for editing multi-line secrets. Example usage: {noformat} <j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form"> <f:entry title="Secret" field="secret"> <f:secretTextarea/> </f:entry> <f:entry title="Secret 2"> <f:secretTextarea field="secret2"/> </f:entry> <f:entry title="Another Secret"> <f:secretTextarea name="foo" value="${it.foo}"/> </f:entry> </j:jelly> {noformat}

    • secretTextarea

      void secretTextarea(groovy.lang.Closure body)
      Enhanced version of <f:textarea/> for editing multi-line secrets. Example usage: {noformat} <j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form"> <f:entry title="Secret" field="secret"> <f:secretTextarea/> </f:entry> <f:entry title="Secret 2"> <f:secretTextarea field="secret2"/> </f:entry> <f:entry title="Another Secret"> <f:secretTextarea name="foo" value="${it.foo}"/> </f:entry> </j:jelly> {noformat}

    • secretTextarea

      void secretTextarea(Map args)
      Enhanced version of <f:textarea/> for editing multi-line secrets. Example usage: {noformat} <j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form"> <f:entry title="Secret" field="secret"> <f:secretTextarea/> </f:entry> <f:entry title="Secret 2"> <f:secretTextarea field="secret2"/> </f:entry> <f:entry title="Another Secret"> <f:secretTextarea name="foo" value="${it.foo}"/> </f:entry> </j:jelly> {noformat}

    • secretTextarea

      void secretTextarea()
      Enhanced version of <f:textarea/> for editing multi-line secrets. Example usage: {noformat} <j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form"> <f:entry title="Secret" field="secret"> <f:secretTextarea/> </f:entry> <f:entry title="Secret 2"> <f:secretTextarea field="secret2"/> </f:entry> <f:entry title="Another Secret"> <f:secretTextarea name="foo" value="${it.foo}"/> </f:entry> </j:jelly> {noformat}

    • advanced

      void advanced(Map args, groovy.lang.Closure body)
      Expandable section that shows "advanced..." button by default. Upon clicking it, a section unfolds, and the HTML rendered by the body of this tag appears.

    • advanced

      void advanced(groovy.lang.Closure body)
      Expandable section that shows "advanced..." button by default. Upon clicking it, a section unfolds, and the HTML rendered by the body of this tag appears.

    • advanced

      void advanced(Map args)
      Expandable section that shows "advanced..." button by default. Upon clicking it, a section unfolds, and the HTML rendered by the body of this tag appears.

    • advanced

      void advanced()
      Expandable section that shows "advanced..." button by default. Upon clicking it, a section unfolds, and the HTML rendered by the body of this tag appears.

    • textbox

      void textbox(Map args, groovy.lang.Closure body)
      Generates an input field to be used inside <f:entry/> For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • textbox

      void textbox(groovy.lang.Closure body)
      Generates an input field to be used inside <f:entry/> For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • textbox

      void textbox(Map args)
      Generates an input field to be used inside <f:entry/> For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • textbox

      void textbox()
      Generates an input field to be used inside <f:entry/> For a read only input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • slave_mode

      @TagFile("slave-mode") void slave_mode(Map args, groovy.lang.Closure body)
      A listbox for choosing the agent's usage.

    • slave_mode

      @TagFile("slave-mode") void slave_mode(groovy.lang.Closure body)
      A listbox for choosing the agent's usage.

    • slave_mode

      @TagFile("slave-mode") void slave_mode(Map args)
      A listbox for choosing the agent's usage.

    • slave_mode

      @TagFile("slave-mode") void slave_mode()
      A listbox for choosing the agent's usage.

    • link

      void link(Map args, groovy.lang.Closure body)
      Generates an anchor element with the ability to send POST requests.
      Since:
      1.584

    • link

      void link(groovy.lang.Closure body)
      Generates an anchor element with the ability to send POST requests.
      Since:
      1.584

    • link

      void link(Map args)
      Generates an anchor element with the ability to send POST requests.
      Since:
      1.584

    • link

      void link()
      Generates an anchor element with the ability to send POST requests.
      Since:
      1.584

    • select

      void select(Map args, groovy.lang.Closure body)
      Glorified <select> control that supports the data binding and AJAX updates. Your descriptor should have the 'doFillXyzItems' method, which returns a ListBoxModel representation of the items in your drop-down list box, and your instance field should hold the current value.

    • select

      void select(groovy.lang.Closure body)
      Glorified <select> control that supports the data binding and AJAX updates. Your descriptor should have the 'doFillXyzItems' method, which returns a ListBoxModel representation of the items in your drop-down list box, and your instance field should hold the current value.

    • select

      void select(Map args)
      Glorified <select> control that supports the data binding and AJAX updates. Your descriptor should have the 'doFillXyzItems' method, which returns a ListBoxModel representation of the items in your drop-down list box, and your instance field should hold the current value.

    • select

      void select()
      Glorified <select> control that supports the data binding and AJAX updates. Your descriptor should have the 'doFillXyzItems' method, which returns a ListBoxModel representation of the items in your drop-down list box, and your instance field should hold the current value.

    • radioBlock

      void radioBlock(Map args, groovy.lang.Closure body)
      Radio button with a label that hides additional controls. When checked, those additional controls are displayed. This is useful for presenting mutually exclusive options, where each option comes with a sub-form that provides additional configuration.

    • radioBlock

      void radioBlock(groovy.lang.Closure body)
      Radio button with a label that hides additional controls. When checked, those additional controls are displayed. This is useful for presenting mutually exclusive options, where each option comes with a sub-form that provides additional configuration.

    • radioBlock

      void radioBlock(Map args)
      Radio button with a label that hides additional controls. When checked, those additional controls are displayed. This is useful for presenting mutually exclusive options, where each option comes with a sub-form that provides additional configuration.

    • radioBlock

      void radioBlock()
      Radio button with a label that hides additional controls. When checked, those additional controls are displayed. This is useful for presenting mutually exclusive options, where each option comes with a sub-form that provides additional configuration.

    • prepareDatabinding

      void prepareDatabinding(Map args, groovy.lang.Closure body)
      Modifies the 'attrs.field' of the parent to inherit @field from the enclosing <f:entry> if available. Also computes the @checkUrl attribute.

    • prepareDatabinding

      void prepareDatabinding(groovy.lang.Closure body)
      Modifies the 'attrs.field' of the parent to inherit @field from the enclosing <f:entry> if available. Also computes the @checkUrl attribute.

    • prepareDatabinding

      void prepareDatabinding(Map args)
      Modifies the 'attrs.field' of the parent to inherit @field from the enclosing <f:entry> if available. Also computes the @checkUrl attribute.

    • prepareDatabinding

      void prepareDatabinding()
      Modifies the 'attrs.field' of the parent to inherit @field from the enclosing <f:entry> if available. Also computes the @checkUrl attribute.

    • toggleSwitch

      void toggleSwitch(Map args, groovy.lang.Closure body)
      <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.

    • toggleSwitch

      void toggleSwitch(groovy.lang.Closure body)
      <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.

    • toggleSwitch

      void toggleSwitch(Map args)
      <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.

    • toggleSwitch

      void toggleSwitch()
      <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.

    • enum_

      @TagFile("enum") void enum_(Map args, groovy.lang.Closure body)
      Binds an enum field to a <select> element. The body of this tag is evaluated for each enum value, which is passed as 'it'.

    • enum_

      @TagFile("enum") void enum_(groovy.lang.Closure body)
      Binds an enum field to a <select> element. The body of this tag is evaluated for each enum value, which is passed as 'it'.

    • enum_

      @TagFile("enum") void enum_(Map args)
      Binds an enum field to a <select> element. The body of this tag is evaluated for each enum value, which is passed as 'it'.

    • enum_

      @TagFile("enum") void enum_()
      Binds an enum field to a <select> element. The body of this tag is evaluated for each enum value, which is passed as 'it'.

    • helpLink

      void helpLink(Map args, groovy.lang.Closure body)
      Outputs a help link for a <f:form> item if help is available or a spacer if none is available. The help link is rendered as a table cell with an (?) icon. If the user clicks it, the content of the HTML fragment at the given URL is rendered in the area designated as <f:helpArea> by the caller, usually in a row beneath the item with help. The alternative spacer is just an empty table cell. This tag was introduced to ensure that the space reserved for help items is consistent over the UI whether or not help exists.
      Since:
      1.576

    • helpLink

      void helpLink(groovy.lang.Closure body)
      Outputs a help link for a <f:form> item if help is available or a spacer if none is available. The help link is rendered as a table cell with an (?) icon. If the user clicks it, the content of the HTML fragment at the given URL is rendered in the area designated as <f:helpArea> by the caller, usually in a row beneath the item with help. The alternative spacer is just an empty table cell. This tag was introduced to ensure that the space reserved for help items is consistent over the UI whether or not help exists.
      Since:
      1.576

    • helpLink

      void helpLink(Map args)
      Outputs a help link for a <f:form> item if help is available or a spacer if none is available. The help link is rendered as a table cell with an (?) icon. If the user clicks it, the content of the HTML fragment at the given URL is rendered in the area designated as <f:helpArea> by the caller, usually in a row beneath the item with help. The alternative spacer is just an empty table cell. This tag was introduced to ensure that the space reserved for help items is consistent over the UI whether or not help exists.
      Since:
      1.576

    • helpLink

      void helpLink()
      Outputs a help link for a <f:form> item if help is available or a spacer if none is available. The help link is rendered as a table cell with an (?) icon. If the user clicks it, the content of the HTML fragment at the given URL is rendered in the area designated as <f:helpArea> by the caller, usually in a row beneath the item with help. The alternative spacer is just an empty table cell. This tag was introduced to ensure that the space reserved for help items is consistent over the UI whether or not help exists.
      Since:
      1.576

    • readOnlyTextbox

      void readOnlyTextbox(Map args, groovy.lang.Closure body)
      Generates an input field to be used inside <f:entry/>

    • readOnlyTextbox

      void readOnlyTextbox(groovy.lang.Closure body)
      Generates an input field to be used inside <f:entry/>

    • readOnlyTextbox

      void readOnlyTextbox(Map args)
      Generates an input field to be used inside <f:entry/>

    • readOnlyTextbox

      void readOnlyTextbox()
      Generates an input field to be used inside <f:entry/>

    • entry

      void entry(Map args, groovy.lang.Closure body)
      An entry of the <f:form>, which is one logical row (that consists of several <TR> tags. One entry normally host one control.

    • entry

      void entry(groovy.lang.Closure body)
      An entry of the <f:form>, which is one logical row (that consists of several <TR> tags. One entry normally host one control.

    • entry

      void entry(Map args)
      An entry of the <f:form>, which is one logical row (that consists of several <TR> tags. One entry normally host one control.

    • entry

      void entry()
      An entry of the <f:form>, which is one logical row (that consists of several <TR> tags. One entry normally host one control.

    • repeatable

      void repeatable(Map args, groovy.lang.Closure body)
      Repeatable blocks used to present UI where the user can configure multiple entries of the same kind (see the Java installations configuration in the system config.) This tag works like <j:forEach> and repeatedly evaluate the body so that initially all the items get their own copy. This tag also evaluate the body once more with var=null to create a 'master copy', which is the template entry used when a new copy is inserted. h4. HTML structure This tag mainly produces the nested DIVs with CSS classes as follows: {noformat} <div class="repeated-container"> // container for the whole thing <div class="repeated-chunk"> ... copy 1 ... <div class="repeated-chunk"> ... copy 2 ... ... {noformat} The 'repeated-chunk' DIVs will also have additional CSS classes that represent their positions among siblings: first : first chunk among the siblings last : last chunk among the siblings middle: neither first nor last only : it is the only chunk (automatically get first and last at the same time) h4. Usage Note The caller of this tag should define a button to add a new copy and delete the current copy. Such buttons should have 'repeatable-add' CSS class and 'repeatable-delete' CSS class respectively (it can have other CSS classes), so that their event handlers get properly wired up. The positional CSS classes on 'repeated-chunk' DIVs (as explained above) can be used to control the visibility of such buttons. For example, this allows you to hide 'delete' button if there's only one item, or only show 'add' button on the last row. There are a few CSS classes already defined in style.css for this purpose.

    • repeatable

      void repeatable(groovy.lang.Closure body)
      Repeatable blocks used to present UI where the user can configure multiple entries of the same kind (see the Java installations configuration in the system config.) This tag works like <j:forEach> and repeatedly evaluate the body so that initially all the items get their own copy. This tag also evaluate the body once more with var=null to create a 'master copy', which is the template entry used when a new copy is inserted. h4. HTML structure This tag mainly produces the nested DIVs with CSS classes as follows: {noformat} <div class="repeated-container"> // container for the whole thing <div class="repeated-chunk"> ... copy 1 ... <div class="repeated-chunk"> ... copy 2 ... ... {noformat} The 'repeated-chunk' DIVs will also have additional CSS classes that represent their positions among siblings: first : first chunk among the siblings last : last chunk among the siblings middle: neither first nor last only : it is the only chunk (automatically get first and last at the same time) h4. Usage Note The caller of this tag should define a button to add a new copy and delete the current copy. Such buttons should have 'repeatable-add' CSS class and 'repeatable-delete' CSS class respectively (it can have other CSS classes), so that their event handlers get properly wired up. The positional CSS classes on 'repeated-chunk' DIVs (as explained above) can be used to control the visibility of such buttons. For example, this allows you to hide 'delete' button if there's only one item, or only show 'add' button on the last row. There are a few CSS classes already defined in style.css for this purpose.

    • repeatable

      void repeatable(Map args)
      Repeatable blocks used to present UI where the user can configure multiple entries of the same kind (see the Java installations configuration in the system config.) This tag works like <j:forEach> and repeatedly evaluate the body so that initially all the items get their own copy. This tag also evaluate the body once more with var=null to create a 'master copy', which is the template entry used when a new copy is inserted. h4. HTML structure This tag mainly produces the nested DIVs with CSS classes as follows: {noformat} <div class="repeated-container"> // container for the whole thing <div class="repeated-chunk"> ... copy 1 ... <div class="repeated-chunk"> ... copy 2 ... ... {noformat} The 'repeated-chunk' DIVs will also have additional CSS classes that represent their positions among siblings: first : first chunk among the siblings last : last chunk among the siblings middle: neither first nor last only : it is the only chunk (automatically get first and last at the same time) h4. Usage Note The caller of this tag should define a button to add a new copy and delete the current copy. Such buttons should have 'repeatable-add' CSS class and 'repeatable-delete' CSS class respectively (it can have other CSS classes), so that their event handlers get properly wired up. The positional CSS classes on 'repeated-chunk' DIVs (as explained above) can be used to control the visibility of such buttons. For example, this allows you to hide 'delete' button if there's only one item, or only show 'add' button on the last row. There are a few CSS classes already defined in style.css for this purpose.

    • repeatable

      void repeatable()
      Repeatable blocks used to present UI where the user can configure multiple entries of the same kind (see the Java installations configuration in the system config.) This tag works like <j:forEach> and repeatedly evaluate the body so that initially all the items get their own copy. This tag also evaluate the body once more with var=null to create a 'master copy', which is the template entry used when a new copy is inserted. h4. HTML structure This tag mainly produces the nested DIVs with CSS classes as follows: {noformat} <div class="repeated-container"> // container for the whole thing <div class="repeated-chunk"> ... copy 1 ... <div class="repeated-chunk"> ... copy 2 ... ... {noformat} The 'repeated-chunk' DIVs will also have additional CSS classes that represent their positions among siblings: first : first chunk among the siblings last : last chunk among the siblings middle: neither first nor last only : it is the only chunk (automatically get first and last at the same time) h4. Usage Note The caller of this tag should define a button to add a new copy and delete the current copy. Such buttons should have 'repeatable-add' CSS class and 'repeatable-delete' CSS class respectively (it can have other CSS classes), so that their event handlers get properly wired up. The positional CSS classes on 'repeated-chunk' DIVs (as explained above) can be used to control the visibility of such buttons. For example, this allows you to hide 'delete' button if there's only one item, or only show 'add' button on the last row. There are a few CSS classes already defined in style.css for this purpose.

    • textarea

      void textarea(Map args, groovy.lang.Closure body)
      <textarea> tag on steroids. The textarea will be rendered to fit the content. It also gets the resize handle.

    • textarea

      void textarea(groovy.lang.Closure body)
      <textarea> tag on steroids. The textarea will be rendered to fit the content. It also gets the resize handle.

    • textarea

      void textarea(Map args)
      <textarea> tag on steroids. The textarea will be rendered to fit the content. It also gets the resize handle.

    • textarea

      void textarea()
      <textarea> tag on steroids. The textarea will be rendered to fit the content. It also gets the resize handle.

    • helpArea

      void helpArea(Map args, groovy.lang.Closure body)
      Place holder to lazy-load help text via AJAX.

    • helpArea

      void helpArea(groovy.lang.Closure body)
      Place holder to lazy-load help text via AJAX.

    • helpArea

      void helpArea(Map args)
      Place holder to lazy-load help text via AJAX.

    • helpArea

      void helpArea()
      Place holder to lazy-load help text via AJAX.

    • radio

      void radio(Map args, groovy.lang.Closure body)
      <input type="radio"> tag that takes true/false for @checked, which is more Jelly friendly. Note that Safari doesn't support onchange. Beware that the name attribute should be uniquified among all radio blocks on the page, such as by prefixing it with "G0025." or whatever gensym. For a read only radio input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • radio

      void radio(groovy.lang.Closure body)
      <input type="radio"> tag that takes true/false for @checked, which is more Jelly friendly. Note that Safari doesn't support onchange. Beware that the name attribute should be uniquified among all radio blocks on the page, such as by prefixing it with "G0025." or whatever gensym. For a read only radio input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • radio

      void radio(Map args)
      <input type="radio"> tag that takes true/false for @checked, which is more Jelly friendly. Note that Safari doesn't support onchange. Beware that the name attribute should be uniquified among all radio blocks on the page, such as by prefixing it with "G0025." or whatever gensym. For a read only radio input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • radio

      void radio()
      <input type="radio"> tag that takes true/false for @checked, which is more Jelly friendly. Note that Safari doesn't support onchange. Beware that the name attribute should be uniquified among all radio blocks on the page, such as by prefixing it with "G0025." or whatever gensym. For a read only radio input set <j:set var="readOnlyMode" value="true"/> inside your entry tag See https://www.jenkins.io/doc/developer/views/read-only/#enabling-read-only-view-support

    • withCustomDescriptorByName

      void withCustomDescriptorByName(Map args, groovy.lang.Closure body)
      Execute the body with a temporary currentDescriptorByNameUrl value

    • withCustomDescriptorByName

      void withCustomDescriptorByName(groovy.lang.Closure body)
      Execute the body with a temporary currentDescriptorByNameUrl value

    • withCustomDescriptorByName

      void withCustomDescriptorByName(Map args)
      Execute the body with a temporary currentDescriptorByNameUrl value

    • withCustomDescriptorByName

      void withCustomDescriptorByName()
      Execute the body with a temporary currentDescriptorByNameUrl value

    • repeatableDeleteButton

      void repeatableDeleteButton(Map args, groovy.lang.Closure body)
      Delete button for the <repeatable> tag.

    • repeatableDeleteButton

      void repeatableDeleteButton(groovy.lang.Closure body)
      Delete button for the <repeatable> tag.

    • repeatableDeleteButton

      void repeatableDeleteButton(Map args)
      Delete button for the <repeatable> tag.

    • repeatableDeleteButton

      void repeatableDeleteButton()
      Delete button for the <repeatable> tag.

    • descriptorList

      void descriptorList(Map args, groovy.lang.Closure body)
      Generate config pages from a list of Descriptors into a section.

    • descriptorList

      void descriptorList(groovy.lang.Closure body)
      Generate config pages from a list of Descriptors into a section.

    • descriptorList

      void descriptorList(Map args)
      Generate config pages from a list of Descriptors into a section.

    • descriptorList

      void descriptorList()
      Generate config pages from a list of Descriptors into a section.

    • checkbox

      void checkbox(Map args, groovy.lang.Closure body)
      <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.

    • checkbox

      void checkbox(groovy.lang.Closure body)
      <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.

    • checkbox

      void checkbox(Map args)
      <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.

    • checkbox

      void checkbox()
      <input type="checkbox"> tag that takes true/false for @checked, which is more Jelly friendly.

    • enumSet

      void enumSet(Map args, groovy.lang.Closure body)
      Binds a set of Enum to a list of checkboxes, each with the label taken from enum Enum.toString() Should be used inside an <f:entry field='...'> element.

    • enumSet

      void enumSet(groovy.lang.Closure body)
      Binds a set of Enum to a list of checkboxes, each with the label taken from enum Enum.toString() Should be used inside an <f:entry field='...'> element.

    • enumSet

      void enumSet(Map args)
      Binds a set of Enum to a list of checkboxes, each with the label taken from enum Enum.toString() Should be used inside an <f:entry field='...'> element.

    • enumSet

      void enumSet()
      Binds a set of Enum to a list of checkboxes, each with the label taken from enum Enum.toString() Should be used inside an <f:entry field='...'> element.

    • booleanRadio

      void booleanRadio(Map args, groovy.lang.Closure body)
      Binds a boolean field to two radio buttons that say Yes/No OK/Cancel Top/Bottom.

    • booleanRadio

      void booleanRadio(groovy.lang.Closure body)
      Binds a boolean field to two radio buttons that say Yes/No OK/Cancel Top/Bottom.

    • booleanRadio

      void booleanRadio(Map args)
      Binds a boolean field to two radio buttons that say Yes/No OK/Cancel Top/Bottom.

    • booleanRadio

      void booleanRadio()
      Binds a boolean field to two radio buttons that say Yes/No OK/Cancel Top/Bottom.