Class BasicRenderingInformation
- java.lang.Object
-
- ro.sync.exml.workspace.api.node.customizer.BasicRenderingInformation
-
- Direct Known Subclasses:
RenderingInformation
@API(type=EXTENDABLE, src=PUBLIC) public class BasicRenderingInformation extends java.lang.Object
The rendering information used to display a node in the Outline view, Author bread crumb, Content Completion popup window, Elements view and DITA Map view.- Since:
- 13.2
-
-
Constructor Summary
Constructors Constructor Description BasicRenderingInformation()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getIconPath()
Get the path of the icon used to render a node.java.lang.String
getRenderedText()
Get the text to be rendered for a node.java.lang.String
getTooltipText()
The tooltip text which will appear in the tooltip associated with the node.void
setIconPath(java.lang.String iconPath)
Set the path of the icon used to render a node.void
setRenderedText(java.lang.String renderedText)
Set the text to be rendered for a node.void
setTooltipText(java.lang.String tooltipText)
The tooltip text which will appear in the tooltip associated with the node.
-
-
-
Method Detail
-
setRenderedText
public void setRenderedText(java.lang.String renderedText)
Set the text to be rendered for a node. If the rendered text isnull
then the default node rendering will be used.- Parameters:
renderedText
- The rendered text, usually the node name. Ifnull
the default text will be used for rendering.
-
setTooltipText
public void setTooltipText(java.lang.String tooltipText)
The tooltip text which will appear in the tooltip associated with the node. If the tooltip text isnull
then the default tooltip text will be used for the node.- Parameters:
tooltipText
- The tooltip text which will appear in the tooltip associated with the node. Ifnull
the default tooltip text will be used for the node.
-
setIconPath
public void setIconPath(java.lang.String iconPath)
Set the path of the icon used to render a node. The path can be an icon file path, the string representation of an iconURL
or can contain editor variables as defined in theEditorVariables
class. The editor variables will be expanded at runtime. If the icon path isnull
the default icon will be used for the node.
If the custom used images are located in the same jar file as theXMLNodeRendererCustomizer
then you can use as the return value for this function the following code sequence:
this.getClass().getResource("/images/Icon.gif").toExternalForm();
The previous sequence assumes that Icon.gif icon image is located in the images folder inside your jar file.- Parameters:
iconPath
- The path of the icon. Ifnull
the default icon will be used for the node.
-
getRenderedText
public java.lang.String getRenderedText()
Get the text to be rendered for a node.- Returns:
- Returns the rendered text.
-
getTooltipText
public java.lang.String getTooltipText()
The tooltip text which will appear in the tooltip associated with the node.- Returns:
- the tooltip text which will appear in the tooltip associated with the node.
-
getIconPath
public java.lang.String getIconPath()
Get the path of the icon used to render a node. The path can be an icon file path, the string representation of an iconURL
or can contain editor variables as defined in theEditorVariables
class. The editor variables will be expanded at runtime.- Returns:
- Returns the path of the icon.
-
-