jetbrains.buildServer.web.util.lazytree
Interface LazyTreeElementRenderer

All Known Implementing Classes:

DefaultLazyTreeElementRenderer

public interface LazyTreeElementRenderer

A control allowing to customize the way the tree element is shown in UI.

Since:

6.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Method Summary

java.lang.String	getCssClassForElement(Element element) Returns the CSS class of the element to use.
java.lang.String	getHrefForLeaf(Element leaf) Returns the href attribute value of the element's link.
java.lang.String	getOnClickForLeaf(Element leaf) Returns the onclick handler of the element's link.
java.lang.String	getTextForElement(Element element) Returns the text representation of an element (usually name).
boolean	ignoreElement(Element element) If returns true, the element and its subtree won't appear in web UI.
void	prepareForRequest(javax.servlet.http.HttpServletRequest request) Allows the renderer to customize its behavious depending on current request.

Method Detail

prepareForRequest

void prepareForRequest(@NotNull
                       javax.servlet.http.HttpServletRequest request)

Allows the renderer to customize its behavious depending on current request.

Parameters:

request - http request

ignoreElement

boolean ignoreElement(@NotNull
                      Element element)

If returns true, the element and its subtree won't appear in web UI. Useful for filtering redundant elements, such as ".svn".

Parameters:

element - the element

Returns:

true if the element should be ignored, false otherwise

getTextForElement

@NotNull
java.lang.String getTextForElement(@NotNull
                                           Element element)

Returns the text representation of an element (usually name). Default implementation returns: StringUtil.escapeHTML(element.getName(), false)).

Parameters:

element - the element to render

Returns:

string representation of the element

getOnClickForLeaf

@Nullable
java.lang.String getOnClickForLeaf(@NotNull
                                            Element leaf)

Returns the onclick handler of the element's link. Method is optional. Applies only to leaf elements.

Parameters:

leaf - the element to render

Returns:

string representation of the onclick handler, or null

getHrefForLeaf

@Nullable
java.lang.String getHrefForLeaf(@NotNull
                                         Element leaf)

Returns the href attribute value of the element's link. Method is optional. Applies only to leaf elements.

Updatd since 7.0: some leaf elements can act as non-leaf ones (e.g. archives). Technically they are not leaves in a tree, but the href attribute is still valid for them.

Parameters:

leaf - the element to render

Returns:

string represetation of the href attribute, or null

getCssClassForElement

@Nullable
java.lang.String getCssClassForElement(@NotNull
                                                Element element)

Returns the CSS class of the element to use. May be applied to all elements.

Parameters:

element - the element to render

Returns:

CSS class, or null if no additional class should be used

Since:

7.0