Interface HtmlDecoratedLabelBuilder
public interface HtmlDecoratedLabelBuilder
Protocol: the following methods can be used only in this order:
1.
2.
3.
4.
Other methods can be used in any order, but each one only once and only before calling
1.
link(PortalLink, boolean)
or link(HtmlLink, boolean)
2.
icon(HtmlLink)
3.
append()
4.
finished()
Other methods can be used in any order, but each one only once and only before calling
finished()
- Since:
- 3.9.0
-
Method Summary
Modifier and TypeMethodDescriptionappend()
Returns builder for appending content.void
finished()
This method will be only for performance improvements in the future, but now it should be called after the client is finished adding content, because it ensures interoperability with some old code.Decorates the label with the icon when the iconUrl is not empty.Decorates the label with the icon when the iconUrl is not empty.The method returns tag builders for each icon created using methodicon(HtmlLink)
oricon(HtmlLink, String)
.iconClassName
(String className) Sets class name to the icon.Decorates the label with the <a> tag with href pointing to the specified link when the link is not empty.link
(PortalLink link, boolean inNewWindow) Decorates the label with the <a> tag with href pointing to the specified link when the link is not empty.styleNoWrap
(boolean value)
-
Method Details
-
iconClassName
Sets class name to the icon. Does nothing if theicon(HtmlLink)
method was not called or called with null. -
append
Returns builder for appending content.- Throws:
IllegalStateException
- afterfinished()
was called.
-
tooltip
- Throws:
IllegalStateException
- afterfinished()
was called.
-
styleNoWrap
- Throws:
IllegalStateException
- afterfinished()
was called.
-
finished
void finished()This method will be only for performance improvements in the future, but now it should be called after the client is finished adding content, because it ensures interoperability with some old code.- Throws:
IllegalStateException
- if already was called before
-
iconBuilders
The method returns tag builders for each icon created using methodicon(HtmlLink)
oricon(HtmlLink, String)
.- Since:
- 3.9.2