Class RenderingInformation
java.lang.Object
ro.sync.exml.workspace.api.node.customizer.BasicRenderingInformation
ro.sync.ecss.extensions.api.structure.RenderingInformation
@API(type=NOT_EXTENDABLE,
src=PUBLIC)
public class RenderingInformation
extends BasicRenderingInformation
The rendering information used to render a node in the outliner and bread crumb.
- Since:
- 11.2
-
Constructor Summary
ConstructorsConstructorDescriptionRenderingInformation
(AuthorNode node, String renderedText, String additionalRenderedText, String tooltipText) RenderingInformation
(AuthorNode node, String renderedText, String additionalRenderedText, String additionalRenderedAttributeValue, String tooltipText) -
Method Summary
Modifier and TypeMethodDescriptionGet the additional rendered attribute value.The additional rendered text.getNode()
boolean
Check if this node should be ignored for display, used only on the breadcrumb.void
setAdditionalRenderedAttributeValue
(String additionalRenderedAttributeValue) Set the additional rendered attribute value.void
setAdditionalRenderedText
(String additionalRenderedText) The additional rendered text.void
setIgnoreNodeFromDisplay
(boolean ignoreNodeFromDisplay) Set this totrue
to ignore this node from being displayed.Methods inherited from class ro.sync.exml.workspace.api.node.customizer.BasicRenderingInformation
getIconPath, getRenderedText, getTooltipText, setIconPath, setRenderedText, setTooltipText
-
Constructor Details
-
RenderingInformation
public RenderingInformation(AuthorNode node, String renderedText, String additionalRenderedText, String tooltipText) - Parameters:
node
- The node to renderrenderedText
- The rendered text. This will be used both in the Outliner and the Bread Crumb. By default it is usually the node name.additionalRenderedText
- The additional rendered text. This will be used only in the Outliner. By default it shows some node text content.tooltipText
- The tooltip text which will appear in the tooltip associated with the node
-
RenderingInformation
public RenderingInformation(AuthorNode node, String renderedText, String additionalRenderedText, String additionalRenderedAttributeValue, String tooltipText) - Parameters:
node
- The node to renderrenderedText
- The rendered text. This will be used both in the Outliner and the Bread Crumb. By default it is usually the node name.additionalRenderedText
- The additional rendered text. This will be used only in the Outliner. By default it shows some node text content .additionalRenderedAttributeValue
- The additional rendered attribute value. This will be used only in the Outliner. By default it shows the value of the first attribute.tooltipText
- The tooltip text which will appear in the tooltip associated with the node
-
-
Method Details
-
setAdditionalRenderedText
The additional rendered text. This will be used only in the Outliner. By default it shows some node text content.- Parameters:
additionalRenderedText
- The additional rendered text. This will be used only in the Outliner. By default it shows some node text content.
-
setAdditionalRenderedAttributeValue
Set the additional rendered attribute value. This will be used only in the Outliner. By default it shows the value of the first attribute.- Parameters:
additionalRenderedAttributeValue
- The additional rendered attribute value.
-
getAdditionalRenderedText
The additional rendered text. This will be used only in the Outliner. By default it shows some node text content.- Returns:
- Returns the additional rendered text. This will be used only in the Outliner. By default it shows the value of the first attribute and some text.
-
getAdditionalRenderedAttributeValue
Get the additional rendered attribute value. This will be used only in the Outliner. By default it shows the value of the first attribute.- Returns:
- Returns the the additional rendered attribute value. This will be used only in the Outliner. By default it shows the value of the first attribute.
-
getNode
- Returns:
- Returns the node to render information for.
-
setIgnoreNodeFromDisplay
public void setIgnoreNodeFromDisplay(boolean ignoreNodeFromDisplay) Set this totrue
to ignore this node from being displayed. This takes effect only on the Breadcrumb Customizer.- Parameters:
ignoreNodeFromDisplay
- Set this totrue
to ignore this node from being displayed.- Since:
- 12.1
-
isIgnoreNodeFromDisplay
public boolean isIgnoreNodeFromDisplay()Check if this node should be ignored for display, used only on the breadcrumb.- Returns:
- Returns
true
to ignore this node from being displayed.
-