Package lib

Interface LayoutTagLib

All Superinterfaces:

groovy.lang.GroovyObject, org.kohsuke.stapler.jelly.groovy.TypedTagLibrary

@TagLibraryUri("/lib/layout")
public interface LayoutTagLib
extends org.kohsuke.stapler.jelly.groovy.TypedTagLibrary

Method Summary

Modifier and Type	Method	Description
void	ajax()	Sets up the same 'global' variables that the l:layout tag does for content loaded by AJAX scripts.
void	ajax(groovy.lang.Closure body)	Sets up the same 'global' variables that the l:layout tag does for content loaded by AJAX scripts.
void	ajax(Map args)	Sets up the same 'global' variables that the l:layout tag does for content loaded by AJAX scripts.
void	ajax(Map args, groovy.lang.Closure body)	Sets up the same 'global' variables that the l:layout tag does for content loaded by AJAX scripts.
void	app_bar()	Generates a row containing the page title and an optional set of controls
void	app_bar(groovy.lang.Closure body)	Generates a row containing the page title and an optional set of controls
void	app_bar(Map args)	Generates a row containing the page title and an optional set of controls
void	app_bar(Map args, groovy.lang.Closure body)	Generates a row containing the page title and an optional set of controls
void	badge()	If a Badge is informed it will be displayed, otherwise nothing is done.
void	badge(groovy.lang.Closure body)	If a Badge is informed it will be displayed, otherwise nothing is done.
void	badge(Map args)	If a Badge is informed it will be displayed, otherwise nothing is done.
void	badge(Map args, groovy.lang.Closure body)	If a Badge is informed it will be displayed, otherwise nothing is done.
void	breadcrumb()	Used inside <l:layout> to render additional breadcrumb items.
void	breadcrumb(groovy.lang.Closure body)	Used inside <l:layout> to render additional breadcrumb items.
void	breadcrumb(Map args)	Used inside <l:layout> to render additional breadcrumb items.
void	breadcrumb(Map args, groovy.lang.Closure body)	Used inside <l:layout> to render additional breadcrumb items.
void	breadcrumbBar()	Generates the bar that shows breadcrumbs, along with its associated dynamic behaviours.
void	breadcrumbBar(groovy.lang.Closure body)	Generates the bar that shows breadcrumbs, along with its associated dynamic behaviours.
void	breadcrumbBar(Map args)	Generates the bar that shows breadcrumbs, along with its associated dynamic behaviours.
void	breadcrumbBar(Map args, groovy.lang.Closure body)	Generates the bar that shows breadcrumbs, along with its associated dynamic behaviours.
void	breakable()	Send escaped value to output decorated to be safely broken into lines when necessary
void	breakable(groovy.lang.Closure body)	Send escaped value to output decorated to be safely broken into lines when necessary
void	breakable(Map args)	Send escaped value to output decorated to be safely broken into lines when necessary
void	breakable(Map args, groovy.lang.Closure body)	Send escaped value to output decorated to be safely broken into lines when necessary
void	card()
void	card(groovy.lang.Closure body)
void	card(Map args)
void	card(Map args, groovy.lang.Closure body)
void	command_palette()	The command palette overlay
void	command_palette(groovy.lang.Closure body)	The command palette overlay
void	command_palette(Map args)	The command palette overlay
void	command_palette(Map args, groovy.lang.Closure body)	The command palette overlay
void	confirmationLink()	Produces a hyperlink which when clicked first asks for confirmation, then goes to that URL if confirmed.
void	confirmationLink(groovy.lang.Closure body)	Produces a hyperlink which when clicked first asks for confirmation, then goes to that URL if confirmed.
void	confirmationLink(Map args)	Produces a hyperlink which when clicked first asks for confirmation, then goes to that URL if confirmed.
void	confirmationLink(Map args, groovy.lang.Closure body)	Produces a hyperlink which when clicked first asks for confirmation, then goes to that URL if confirmed.
void	copyButton()	Button that copies text into the user's clipboard upon click, either or is required.
void	copyButton(groovy.lang.Closure body)	Button that copies text into the user's clipboard upon click, either or is required.
void	copyButton(Map args)	Button that copies text into the user's clipboard upon click, either or is required.
void	copyButton(Map args, groovy.lang.Closure body)	Button that copies text into the user's clipboard upon click, either or is required.
void	delete()	Creates a delete link with confirmation and trashcan icon in the left navigation pane of Jenkins.
void	delete(groovy.lang.Closure body)	Creates a delete link with confirmation and trashcan icon in the left navigation pane of Jenkins.
void	delete(Map args)	Creates a delete link with confirmation and trashcan icon in the left navigation pane of Jenkins.
void	delete(Map args, groovy.lang.Closure body)	Creates a delete link with confirmation and trashcan icon in the left navigation pane of Jenkins.
void	hasAdministerOrManage()
void	hasAdministerOrManage(groovy.lang.Closure body)
void	hasAdministerOrManage(Map args)
void	hasAdministerOrManage(Map args, groovy.lang.Closure body)
void	hasPermission()	Renders the body only if the current user has the specified permission
void	hasPermission(groovy.lang.Closure body)	Renders the body only if the current user has the specified permission
void	hasPermission(Map args)	Renders the body only if the current user has the specified permission
void	hasPermission(Map args, groovy.lang.Closure body)	Renders the body only if the current user has the specified permission
void	header()	Header portion of the HTML page, that gets rendered into the <head> tag.
void	header(groovy.lang.Closure body)	Header portion of the HTML page, that gets rendered into the <head> tag.
void	header(Map args)	Header portion of the HTML page, that gets rendered into the <head> tag.
void	header(Map args, groovy.lang.Closure body)	Header portion of the HTML page, that gets rendered into the <head> tag.
void	helpIcon()	Outputs a help icon The help link is rendered as an SVG with an (?) icon.
void	helpIcon(groovy.lang.Closure body)	Outputs a help icon The help link is rendered as an SVG with an (?) icon.
void	helpIcon(Map args)	Outputs a help icon The help link is rendered as an SVG with an (?) icon.
void	helpIcon(Map args, groovy.lang.Closure body)	Outputs a help icon The help link is rendered as an SVG with an (?) icon.
void	icon()
void	icon(groovy.lang.Closure body)
void	icon(Map args)
void	icon(Map args, groovy.lang.Closure body)
void	isAdmin()
void	isAdmin(groovy.lang.Closure body)
void	isAdmin(Map args)
void	isAdmin(Map args, groovy.lang.Closure body)
void	isAdminOrTest()	Deprecated, do not use.
void	isAdminOrTest(groovy.lang.Closure body)	Deprecated, do not use.
void	isAdminOrTest(Map args)	Deprecated, do not use.
void	isAdminOrTest(Map args, groovy.lang.Closure body)	Deprecated, do not use.
void	keyboard_shortcut()	Displays a keyboard shortcut chip
void	keyboard_shortcut(groovy.lang.Closure body)	Displays a keyboard shortcut chip
void	keyboard_shortcut(Map args)	Displays a keyboard shortcut chip
void	keyboard_shortcut(Map args, groovy.lang.Closure body)	Displays a keyboard shortcut chip
void	layout()	Outer-most tag for a normal (non-AJAX) HTML rendering.
void	layout(groovy.lang.Closure body)	Outer-most tag for a normal (non-AJAX) HTML rendering.
void	layout(Map args)	Outer-most tag for a normal (non-AJAX) HTML rendering.
void	layout(Map args, groovy.lang.Closure body)	Outer-most tag for a normal (non-AJAX) HTML rendering.
void	main_panel()	Generates the body as the main content part of a Jenkins page.
void	main_panel(groovy.lang.Closure body)	Generates the body as the main content part of a Jenkins page.
void	main_panel(Map args)	Generates the body as the main content part of a Jenkins page.
void	main_panel(Map args, groovy.lang.Closure body)	Generates the body as the main content part of a Jenkins page.
void	notice()
void	notice(groovy.lang.Closure body)
void	notice(Map args)
void	notice(Map args, groovy.lang.Closure body)
void	overflowButton()	Displays a button which when clicked displays a dropdown of the component's children
void	overflowButton(groovy.lang.Closure body)	Displays a button which when clicked displays a dropdown of the component's children
void	overflowButton(Map args)	Displays a button which when clicked displays a dropdown of the component's children
void	overflowButton(Map args, groovy.lang.Closure body)	Displays a button which when clicked displays a dropdown of the component's children
void	pageHeader()	Generates the page header, along with its associated dynamic behaviours.
void	pageHeader(groovy.lang.Closure body)	Generates the page header, along with its associated dynamic behaviours.
void	pageHeader(Map args)	Generates the page header, along with its associated dynamic behaviours.
void	pageHeader(Map args, groovy.lang.Closure body)	Generates the page header, along with its associated dynamic behaviours.
void	pane()	Used in the <l:side-panel> to draw a box with a title.
void	pane(groovy.lang.Closure body)	Used in the <l:side-panel> to draw a box with a title.
void	pane(Map args)	Used in the <l:side-panel> to draw a box with a title.
void	pane(Map args, groovy.lang.Closure body)	Used in the <l:side-panel> to draw a box with a title.
void	progressAnimation()	Display a CSS animation for progressive logging.
void	progressAnimation(groovy.lang.Closure body)	Display a CSS animation for progressive logging.
void	progressAnimation(Map args)	Display a CSS animation for progressive logging.
void	progressAnimation(Map args, groovy.lang.Closure body)	Display a CSS animation for progressive logging.
void	progressiveRendering()
void	progressiveRendering(groovy.lang.Closure body)
void	progressiveRendering(Map args)
void	progressiveRendering(Map args, groovy.lang.Closure body)
void	renderOnDemand()
void	renderOnDemand(groovy.lang.Closure body)
void	renderOnDemand(Map args)
void	renderOnDemand(Map args, groovy.lang.Closure body)
void	rightspace()	Creates a space for the right-hand side of the page.
void	rightspace(groovy.lang.Closure body)	Creates a space for the right-hand side of the page.
void	rightspace(Map args)	Creates a space for the right-hand side of the page.
void	rightspace(Map args, groovy.lang.Closure body)	Creates a space for the right-hand side of the page.
void	rowSelectionController()	Controls checkbox selections in tables
void	rowSelectionController(groovy.lang.Closure body)	Controls checkbox selections in tables
void	rowSelectionController(Map args)	Controls checkbox selections in tables
void	rowSelectionController(Map args, groovy.lang.Closure body)	Controls checkbox selections in tables
void	search_bar()	Creates a search input
void	search_bar(groovy.lang.Closure body)	Creates a search input
void	search_bar(Map args)	Creates a search input
void	search_bar(Map args, groovy.lang.Closure body)	Creates a search input
void	side_panel()	Generates a left side content as part of a Jenkins page.
void	side_panel(groovy.lang.Closure body)	Generates a left side content as part of a Jenkins page.
void	side_panel(Map args)	Generates a left side content as part of a Jenkins page.
void	side_panel(Map args, groovy.lang.Closure body)	Generates a left side content as part of a Jenkins page.
void	skeleton()	Placeholder skeleton element, hiding the rest of its parent container until the page has loaded
void	skeleton(groovy.lang.Closure body)	Placeholder skeleton element, hiding the rest of its parent container until the page has loaded
void	skeleton(Map args)	Placeholder skeleton element, hiding the rest of its parent container until the page has loaded
void	skeleton(Map args, groovy.lang.Closure body)	Placeholder skeleton element, hiding the rest of its parent container until the page has loaded
void	spinner()	Customizable spinner component
void	spinner(groovy.lang.Closure body)	Customizable spinner component
void	spinner(Map args)	Customizable spinner component
void	spinner(Map args, groovy.lang.Closure body)	Customizable spinner component
void	stopButton()	Creates a clickable "Stop" button.
void	stopButton(groovy.lang.Closure body)	Creates a clickable "Stop" button.
void	stopButton(Map args)	Creates a clickable "Stop" button.
void	stopButton(Map args, groovy.lang.Closure body)	Creates a clickable "Stop" button.
void	svgIcon()	Opinionated helper to use icons via <svg> tags.
void	svgIcon(groovy.lang.Closure body)	Opinionated helper to use icons via <svg> tags.
void	svgIcon(Map args)	Opinionated helper to use icons via <svg> tags.
void	svgIcon(Map args, groovy.lang.Closure body)	Opinionated helper to use icons via <svg> tags.
void	tab()
void	tab(groovy.lang.Closure body)
void	tab(Map args)
void	tab(Map args, groovy.lang.Closure body)
void	tabBar()
void	tabBar(groovy.lang.Closure body)
void	tabBar(Map args)
void	tabBar(Map args, groovy.lang.Closure body)
void	tabNewItem()
void	tabNewItem(groovy.lang.Closure body)
void	tabNewItem(Map args)
void	tabNewItem(Map args, groovy.lang.Closure body)
void	tabPane()
void	tabPane(groovy.lang.Closure body)
void	tabPane(Map args)
void	tabPane(Map args, groovy.lang.Closure body)
void	task()	This tag inside <l:tasks> tag renders the left navigation bar of Jenkins.
void	task(groovy.lang.Closure body)	This tag inside <l:tasks> tag renders the left navigation bar of Jenkins.
void	task(Map args)	This tag inside <l:tasks> tag renders the left navigation bar of Jenkins.
void	task(Map args, groovy.lang.Closure body)	This tag inside <l:tasks> tag renders the left navigation bar of Jenkins.
void	tasks()
void	tasks(groovy.lang.Closure body)
void	tasks(Map args)
void	tasks(Map args, groovy.lang.Closure body)
void	userExperimentalFlag()	Retrieve the value of a given experimental flag for the current user.
void	userExperimentalFlag(groovy.lang.Closure body)	Retrieve the value of a given experimental flag for the current user.
void	userExperimentalFlag(Map args)	Retrieve the value of a given experimental flag for the current user.
void	userExperimentalFlag(Map args, groovy.lang.Closure body)	Retrieve the value of a given experimental flag for the current user.
void	view()	Declares a view as dispatchable.
void	view(groovy.lang.Closure body)	Declares a view as dispatchable.
void	view(Map args)	Declares a view as dispatchable.
void	view(Map args, groovy.lang.Closure body)	Declares a view as dispatchable.
void	yui()	Do not use this tag, YUI has been removed from Jenkins
void	yui(groovy.lang.Closure body)	Do not use this tag, YUI has been removed from Jenkins
void	yui(Map args)	Do not use this tag, YUI has been removed from Jenkins
void	yui(Map args, groovy.lang.Closure body)	Do not use this tag, YUI has been removed from Jenkins

Methods inherited from interface groovy.lang.GroovyObject

getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty

Method Details

ajax

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

Sets up the same 'global' variables that the l:layout tag does for content loaded by AJAX scripts.

ajax

void ajax(groovy.lang.Closure body)

Sets up the same 'global' variables that the l:layout tag does for content loaded by AJAX scripts.

ajax

void ajax(Map args)

Sets up the same 'global' variables that the l:layout tag does for content loaded by AJAX scripts.

ajax

void ajax()

Sets up the same 'global' variables that the l:layout tag does for content loaded by AJAX scripts.

app_bar

@TagFile("app-bar")
void app_bar(Map args,
 groovy.lang.Closure body)

Generates a row containing the page title and an optional set of controls

app_bar

@TagFile("app-bar")
void app_bar(groovy.lang.Closure body)

Generates a row containing the page title and an optional set of controls

app_bar

@TagFile("app-bar")
void app_bar(Map args)

Generates a row containing the page title and an optional set of controls

app_bar

@TagFile("app-bar")
void app_bar()

Generates a row containing the page title and an optional set of controls

badge

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

If a Badge is informed it will be displayed, otherwise nothing is done.

Since:

2.445

badge

void badge(groovy.lang.Closure body)

If a Badge is informed it will be displayed, otherwise nothing is done.

Since:

2.445

badge

void badge(Map args)

If a Badge is informed it will be displayed, otherwise nothing is done.

Since:

2.445

badge

void badge()

If a Badge is informed it will be displayed, otherwise nothing is done.

Since:

2.445

breadcrumb

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

Used inside <l:layout> to render additional breadcrumb items.

breadcrumb

void breadcrumb(groovy.lang.Closure body)

Used inside <l:layout> to render additional breadcrumb items.

breadcrumb

void breadcrumb(Map args)

Used inside <l:layout> to render additional breadcrumb items.

breadcrumb

void breadcrumb()

Used inside <l:layout> to render additional breadcrumb items.

breadcrumbBar

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

Generates the bar that shows breadcrumbs, along with its associated dynamic behaviours. This tag is used by l:layout and not expected to be used by anyone else, but it's written as separate tag for better readability of code. To render additional breadcrumb items (for example to provide in-page navigations), use the <l:breadcrumb> tag.

breadcrumbBar

void breadcrumbBar(groovy.lang.Closure body)

Generates the bar that shows breadcrumbs, along with its associated dynamic behaviours. This tag is used by l:layout and not expected to be used by anyone else, but it's written as separate tag for better readability of code. To render additional breadcrumb items (for example to provide in-page navigations), use the <l:breadcrumb> tag.

breadcrumbBar

void breadcrumbBar(Map args)

Generates the bar that shows breadcrumbs, along with its associated dynamic behaviours. This tag is used by l:layout and not expected to be used by anyone else, but it's written as separate tag for better readability of code. To render additional breadcrumb items (for example to provide in-page navigations), use the <l:breadcrumb> tag.

breadcrumbBar

void breadcrumbBar()

Generates the bar that shows breadcrumbs, along with its associated dynamic behaviours. This tag is used by l:layout and not expected to be used by anyone else, but it's written as separate tag for better readability of code. To render additional breadcrumb items (for example to provide in-page navigations), use the <l:breadcrumb> tag.

breakable

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

Send escaped value to output decorated to be safely broken into lines when necessary

Since:

1.517

breakable

void breakable(groovy.lang.Closure body)

Send escaped value to output decorated to be safely broken into lines when necessary

Since:

1.517

breakable

void breakable(Map args)

Send escaped value to output decorated to be safely broken into lines when necessary

Since:

1.517

breakable

void breakable()

Send escaped value to output decorated to be safely broken into lines when necessary

Since:

1.517

card

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

card

void card(groovy.lang.Closure body)

card

void card(Map args)

card

void card()

command_palette

@TagFile("command-palette")
void command_palette(Map args,
 groovy.lang.Closure body)

The command palette overlay

command_palette

@TagFile("command-palette")
void command_palette(groovy.lang.Closure body)

The command palette overlay

command_palette

@TagFile("command-palette")
void command_palette(Map args)

The command palette overlay

command_palette

@TagFile("command-palette")
void command_palette()

The command palette overlay

confirmationLink

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

Produces a hyperlink which when clicked first asks for confirmation, then goes to that URL if confirmed. The body is displayed as the link text.

Since:

1.512

confirmationLink

void confirmationLink(groovy.lang.Closure body)

Produces a hyperlink which when clicked first asks for confirmation, then goes to that URL if confirmed. The body is displayed as the link text.

Since:

1.512

confirmationLink

void confirmationLink(Map args)

Produces a hyperlink which when clicked first asks for confirmation, then goes to that URL if confirmed. The body is displayed as the link text.

Since:

1.512

confirmationLink

void confirmationLink()

Produces a hyperlink which when clicked first asks for confirmation, then goes to that URL if confirmed. The body is displayed as the link text.

Since:

1.512

copyButton

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

Button that copies text into the user's clipboard upon click, either or is required.

copyButton

void copyButton(groovy.lang.Closure body)

Button that copies text into the user's clipboard upon click, either or is required.

copyButton

void copyButton(Map args)

Button that copies text into the user's clipboard upon click, either or is required.

copyButton

void copyButton()

Button that copies text into the user's clipboard upon click, either or is required.

delete

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

Creates a delete link with confirmation and trashcan icon in the left navigation pane of Jenkins. Requires that the target has implemented the doDoDelete method.

Since:

2.415

delete

void delete(groovy.lang.Closure body)

Creates a delete link with confirmation and trashcan icon in the left navigation pane of Jenkins. Requires that the target has implemented the doDoDelete method.

Since:

2.415

delete

void delete(Map args)

Creates a delete link with confirmation and trashcan icon in the left navigation pane of Jenkins. Requires that the target has implemented the doDoDelete method.

Since:

2.415

delete

void delete()

Creates a delete link with confirmation and trashcan icon in the left navigation pane of Jenkins. Requires that the target has implemented the doDoDelete method.

Since:

2.415

hasAdministerOrManage

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

hasAdministerOrManage

void hasAdministerOrManage(groovy.lang.Closure body)

hasAdministerOrManage

void hasAdministerOrManage(Map args)

hasAdministerOrManage

void hasAdministerOrManage()

hasPermission

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

Renders the body only if the current user has the specified permission

hasPermission

void hasPermission(groovy.lang.Closure body)

Renders the body only if the current user has the specified permission

hasPermission

void hasPermission(Map args)

Renders the body only if the current user has the specified permission

hasPermission

void hasPermission()

Renders the body only if the current user has the specified permission

header

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

Header portion of the HTML page, that gets rendered into the <head> tag. Multiple <l:header> elements can be specified, and can even come after <l:main-panel>. This tag can be placed inside <l:layout>.

header

void header(groovy.lang.Closure body)

Header portion of the HTML page, that gets rendered into the <head> tag. Multiple <l:header> elements can be specified, and can even come after <l:main-panel>. This tag can be placed inside <l:layout>.

header

void header(Map args)

Header portion of the HTML page, that gets rendered into the <head> tag. Multiple <l:header> elements can be specified, and can even come after <l:main-panel>. This tag can be placed inside <l:layout>.

header

void header()

Header portion of the HTML page, that gets rendered into the <head> tag. Multiple <l:header> elements can be specified, and can even come after <l:main-panel>. This tag can be placed inside <l:layout>.

helpIcon

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

Outputs a help icon The help link is rendered as an SVG with an (?) icon.

Since:

2.234

helpIcon

void helpIcon(groovy.lang.Closure body)

Outputs a help icon The help link is rendered as an SVG with an (?) icon.

Since:

2.234

helpIcon

void helpIcon(Map args)

Outputs a help icon The help link is rendered as an SVG with an (?) icon.

Since:

2.234

helpIcon

void helpIcon()

Outputs a help icon The help link is rendered as an SVG with an (?) icon.

Since:

2.234

icon

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

Since:

1.576

icon

void icon(groovy.lang.Closure body)

Since:

1.576

icon

void icon(Map args)

Since:

1.576

icon

void icon()

Since:

1.576

isAdmin

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

isAdmin

void isAdmin(groovy.lang.Closure body)

isAdmin

void isAdmin(Map args)

isAdmin

void isAdmin()

isAdminOrTest

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

Deprecated, do not use.

isAdminOrTest

void isAdminOrTest(groovy.lang.Closure body)

Deprecated, do not use.

isAdminOrTest

void isAdminOrTest(Map args)

Deprecated, do not use.

isAdminOrTest

void isAdminOrTest()

Deprecated, do not use.

keyboard_shortcut

@TagFile("keyboard-shortcut")
void keyboard_shortcut(Map args,
 groovy.lang.Closure body)

Displays a keyboard shortcut chip

keyboard_shortcut

@TagFile("keyboard-shortcut")
void keyboard_shortcut(groovy.lang.Closure body)

Displays a keyboard shortcut chip

keyboard_shortcut

@TagFile("keyboard-shortcut")
void keyboard_shortcut(Map args)

Displays a keyboard shortcut chip

keyboard_shortcut

@TagFile("keyboard-shortcut")
void keyboard_shortcut()

Displays a keyboard shortcut chip

layout

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

Outer-most tag for a normal (non-AJAX) HTML rendering. This is used with nested <header>, <side-panel>, and <main-panel> to form Jenkins's basic HTML layout.

layout

void layout(groovy.lang.Closure body)

Outer-most tag for a normal (non-AJAX) HTML rendering. This is used with nested <header>, <side-panel>, and <main-panel> to form Jenkins's basic HTML layout.

layout

void layout(Map args)

Outer-most tag for a normal (non-AJAX) HTML rendering. This is used with nested <header>, <side-panel>, and <main-panel> to form Jenkins's basic HTML layout.

layout

void layout()

Outer-most tag for a normal (non-AJAX) HTML rendering. This is used with nested <header>, <side-panel>, and <main-panel> to form Jenkins's basic HTML layout.

main_panel

@TagFile("main-panel")
void main_panel(Map args,
 groovy.lang.Closure body)

Generates the body as the main content part of a Jenkins page.

main_panel

@TagFile("main-panel")
void main_panel(groovy.lang.Closure body)

Generates the body as the main content part of a Jenkins page.

main_panel

@TagFile("main-panel")
void main_panel(Map args)

Generates the body as the main content part of a Jenkins page.

main_panel

@TagFile("main-panel")
void main_panel()

Generates the body as the main content part of a Jenkins page.

notice

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

notice

void notice(groovy.lang.Closure body)

notice

void notice(Map args)

notice

void notice()

overflowButton

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

Displays a button which when clicked displays a dropdown of the component's children

overflowButton

void overflowButton(groovy.lang.Closure body)

Displays a button which when clicked displays a dropdown of the component's children

overflowButton

void overflowButton(Map args)

Displays a button which when clicked displays a dropdown of the component's children

overflowButton

void overflowButton()

Displays a button which when clicked displays a dropdown of the component's children

pageHeader

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

Generates the page header, along with its associated dynamic behaviours. This tag is used by l:layout and not expected to be used by anyone else, but it's written as separate tag for better readability of code.

pageHeader

void pageHeader(groovy.lang.Closure body)

Generates the page header, along with its associated dynamic behaviours. This tag is used by l:layout and not expected to be used by anyone else, but it's written as separate tag for better readability of code.

pageHeader

void pageHeader(Map args)

Generates the page header, along with its associated dynamic behaviours. This tag is used by l:layout and not expected to be used by anyone else, but it's written as separate tag for better readability of code.

pageHeader

void pageHeader()

Generates the page header, along with its associated dynamic behaviours. This tag is used by l:layout and not expected to be used by anyone else, but it's written as separate tag for better readability of code.

pane

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

Used in the <l:side-panel> to draw a box with a title. The box is drawn as a table, and the body of this tag is expected to draw a series of <TR>s to fill in the contents of the box.

pane

void pane(groovy.lang.Closure body)

Used in the <l:side-panel> to draw a box with a title. The box is drawn as a table, and the body of this tag is expected to draw a series of <TR>s to fill in the contents of the box.

pane

void pane(Map args)

Used in the <l:side-panel> to draw a box with a title. The box is drawn as a table, and the body of this tag is expected to draw a series of <TR>s to fill in the contents of the box.

pane

void pane()

Used in the <l:side-panel> to draw a box with a title. The box is drawn as a table, and the body of this tag is expected to draw a series of <TR>s to fill in the contents of the box.

progressAnimation

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

Display a CSS animation for progressive logging. This tag supersedes spinner.gif and is a drop in replacement: From {noformat}<img src="${imagesURL}/spinner.gif" alt=""/>{noformat} to {noformat}<l:progressAnimation/>{noformat}

Since:

2.320

progressAnimation

void progressAnimation(groovy.lang.Closure body)

Display a CSS animation for progressive logging. This tag supersedes spinner.gif and is a drop in replacement: From {noformat}<img src="${imagesURL}/spinner.gif" alt=""/>{noformat} to {noformat}<l:progressAnimation/>{noformat}

Since:

2.320

progressAnimation

void progressAnimation(Map args)

Display a CSS animation for progressive logging. This tag supersedes spinner.gif and is a drop in replacement: From {noformat}<img src="${imagesURL}/spinner.gif" alt=""/>{noformat} to {noformat}<l:progressAnimation/>{noformat}

Since:

2.320

progressAnimation

void progressAnimation()

Display a CSS animation for progressive logging. This tag supersedes spinner.gif and is a drop in replacement: From {noformat}<img src="${imagesURL}/spinner.gif" alt=""/>{noformat} to {noformat}<l:progressAnimation/>{noformat}

Since:

2.320

progressiveRendering

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

progressiveRendering

void progressiveRendering(groovy.lang.Closure body)

progressiveRendering

void progressiveRendering(Map args)

progressiveRendering

void progressiveRendering()

renderOnDemand

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

renderOnDemand

void renderOnDemand(groovy.lang.Closure body)

renderOnDemand

void renderOnDemand(Map args)

renderOnDemand

void renderOnDemand()

rightspace

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

Creates a space for the right-hand side of the page. This sticks to the right of the page even when the content overflows.

rightspace

void rightspace(groovy.lang.Closure body)

Creates a space for the right-hand side of the page. This sticks to the right of the page even when the content overflows.

rightspace

void rightspace(Map args)

Creates a space for the right-hand side of the page. This sticks to the right of the page even when the content overflows.

rightspace

void rightspace()

Creates a space for the right-hand side of the page. This sticks to the right of the page even when the content overflows.

rowSelectionController

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

Controls checkbox selections in tables

rowSelectionController

void rowSelectionController(groovy.lang.Closure body)

Controls checkbox selections in tables

rowSelectionController

void rowSelectionController(Map args)

Controls checkbox selections in tables

rowSelectionController

void rowSelectionController()

Controls checkbox selections in tables

search_bar

@TagFile("search-bar")
void search_bar(Map args,
 groovy.lang.Closure body)

Creates a search input

Since:

2.369

search_bar

@TagFile("search-bar")
void search_bar(groovy.lang.Closure body)

Creates a search input

Since:

2.369

search_bar

@TagFile("search-bar")
void search_bar(Map args)

Creates a search input

Since:

2.369

search_bar

@TagFile("search-bar")
void search_bar()

Creates a search input

Since:

2.369

side_panel

@TagFile("side-panel")
void side_panel(Map args,
 groovy.lang.Closure body)

Generates a left side content as part of a Jenkins page. Typically known as two-column or left-side + main-content layouts

side_panel

@TagFile("side-panel")
void side_panel(groovy.lang.Closure body)

Generates a left side content as part of a Jenkins page. Typically known as two-column or left-side + main-content layouts

side_panel

@TagFile("side-panel")
void side_panel(Map args)

Generates a left side content as part of a Jenkins page. Typically known as two-column or left-side + main-content layouts

side_panel

@TagFile("side-panel")
void side_panel()

Generates a left side content as part of a Jenkins page. Typically known as two-column or left-side + main-content layouts

skeleton

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

Placeholder skeleton element, hiding the rest of its parent container until the page has loaded

skeleton

void skeleton(groovy.lang.Closure body)

Placeholder skeleton element, hiding the rest of its parent container until the page has loaded

skeleton

void skeleton(Map args)

Placeholder skeleton element, hiding the rest of its parent container until the page has loaded

skeleton

void skeleton()

Placeholder skeleton element, hiding the rest of its parent container until the page has loaded

spinner

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

Customizable spinner component

spinner

void spinner(groovy.lang.Closure body)

Customizable spinner component

spinner

void spinner(Map args)

Customizable spinner component

spinner

void spinner()

Customizable spinner component

stopButton

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

Creates a clickable "Stop" button.

stopButton

void stopButton(groovy.lang.Closure body)

Creates a clickable "Stop" button.

stopButton

void stopButton(Map args)

Creates a clickable "Stop" button.

stopButton

void stopButton()

Creates a clickable "Stop" button.

svgIcon

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

Opinionated helper to use icons via <svg> tags. Can be used by passing a href or a body: {noformat} # <l:svgIcon href="/path/to/my/sprite.svg#my-icon" /> # <l:svgIcon><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"></path></l:svgIcon> {noformat}

Since:

2.222

svgIcon

void svgIcon(groovy.lang.Closure body)

Opinionated helper to use icons via <svg> tags. Can be used by passing a href or a body: {noformat} # <l:svgIcon href="/path/to/my/sprite.svg#my-icon" /> # <l:svgIcon><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"></path></l:svgIcon> {noformat}

Since:

2.222

svgIcon

void svgIcon(Map args)

Opinionated helper to use icons via <svg> tags. Can be used by passing a href or a body: {noformat} # <l:svgIcon href="/path/to/my/sprite.svg#my-icon" /> # <l:svgIcon><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"></path></l:svgIcon> {noformat}

Since:

2.222

svgIcon

void svgIcon()

Opinionated helper to use icons via <svg> tags. Can be used by passing a href or a body: {noformat} # <l:svgIcon href="/path/to/my/sprite.svg#my-icon" /> # <l:svgIcon><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"></path></l:svgIcon> {noformat}

Since:

2.222

tab

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

tab

void tab(groovy.lang.Closure body)

tab

void tab(Map args)

tab

void tab()

tabBar

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

tabBar

void tabBar(groovy.lang.Closure body)

tabBar

void tabBar(Map args)

tabBar

void tabBar()

tabNewItem

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

tabNewItem

void tabNewItem(groovy.lang.Closure body)

tabNewItem

void tabNewItem(Map args)

tabNewItem

void tabNewItem()

tabPane

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

Since:

2.385

tabPane

void tabPane(groovy.lang.Closure body)

Since:

2.385

tabPane

void tabPane(Map args)

Since:

2.385

tabPane

void tabPane()

Since:

2.385

task

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

This tag inside <l:tasks> tag renders the left navigation bar of Jenkins. Each <task> tag gets an icon and link.

task

void task(groovy.lang.Closure body)

This tag inside <l:tasks> tag renders the left navigation bar of Jenkins. Each <task> tag gets an icon and link.

task

void task(Map args)

This tag inside <l:tasks> tag renders the left navigation bar of Jenkins. Each <task> tag gets an icon and link.

task

void task()

This tag inside <l:tasks> tag renders the left navigation bar of Jenkins. Each <task> tag gets an icon and link.

tasks

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

tasks

void tasks(groovy.lang.Closure body)

tasks

void tasks(Map args)

tasks

void tasks()

userExperimentalFlag

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

Retrieve the value of a given experimental flag for the current user.

userExperimentalFlag

void userExperimentalFlag(groovy.lang.Closure body)

Retrieve the value of a given experimental flag for the current user.

userExperimentalFlag

void userExperimentalFlag(Map args)

Retrieve the value of a given experimental flag for the current user.

userExperimentalFlag

void userExperimentalFlag()

Retrieve the value of a given experimental flag for the current user.

view

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

Declares a view as dispatchable. Views that do not use this tag or another tag that invokes this are considered fragment views and are not dispatchable.

view

void view(groovy.lang.Closure body)

Declares a view as dispatchable. Views that do not use this tag or another tag that invokes this are considered fragment views and are not dispatchable.

view

void view(Map args)

Declares a view as dispatchable. Views that do not use this tag or another tag that invokes this are considered fragment views and are not dispatchable.

view

void view()

Declares a view as dispatchable. Views that do not use this tag or another tag that invokes this are considered fragment views and are not dispatchable.

yui

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

Do not use this tag, YUI has been removed from Jenkins

yui

void yui(groovy.lang.Closure body)

Do not use this tag, YUI has been removed from Jenkins

yui

void yui(Map args)

Do not use this tag, YUI has been removed from Jenkins

yui

void yui()

Do not use this tag, YUI has been removed from Jenkins