ro.sync.ecss.extensions.api.structure
Class RenderingInformation

java.lang.Object
  ro.sync.ecss.extensions.api.structure.RenderingInformation

public class RenderingInformation
extends java.lang.Object

The rendering information used to render a node in the outliner and bread crumb.

Since:

11.2

Constructor Summary

RenderingInformation(AuthorNode node, java.lang.String renderedText, java.lang.String additionalRenderedText, java.lang.String tooltipText)

RenderingInformation(AuthorNode node, java.lang.String renderedText, java.lang.String additionalRenderedText, java.lang.String additionalRenderedAttributeValue, java.lang.String tooltipText)

Method Summary

java.lang.String	getAdditionalRenderedAttributeValue() Get the additional rendered attribute value.
java.lang.String	getAdditionalRenderedText() The additional rendered text.
AuthorNode	getNode()
java.lang.String	getRenderedText() The rendered text.
java.lang.String	getTooltipText() The tooltip text which will appear in the tooltip associated with the node.
boolean	isIgnoreNodeFromDisplay() Check if this node should be ignored for display, used only on the breadcrumb.
void	setAdditionalRenderedAttributeValue(java.lang.String additionalRenderedAttributeValue) Set the additional rendered attribute value.
void	setAdditionalRenderedText(java.lang.String additionalRenderedText) The additional rendered text.
void	setIgnoreNodeFromDisplay(boolean ignoreNodeFromDisplay) Set this to true to ignore this node from being displayed.
void	setRenderedText(java.lang.String renderedText) The rendered text.
void	setTooltipText(java.lang.String tooltipText) The tooltip text which will appear in the tooltip associated with the node

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RenderingInformation

public RenderingInformation(AuthorNode node,
                            java.lang.String renderedText,
                            java.lang.String additionalRenderedText,
                            java.lang.String tooltipText)

Parameters:

node - The node to render

renderedText - 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,
                            java.lang.String renderedText,
                            java.lang.String additionalRenderedText,
                            java.lang.String additionalRenderedAttributeValue,
                            java.lang.String tooltipText)

Parameters:

node - The node to render

renderedText - 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 Detail

setRenderedText

public void setRenderedText(java.lang.String renderedText)

The rendered text. This will be used both in the Outliner and the Bread Crumb.

Parameters:

renderedText - The rendered text. This will be used both in the Outliner and the Bread Crumb.

setAdditionalRenderedText

public void setAdditionalRenderedText(java.lang.String additionalRenderedText)

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

public void setAdditionalRenderedAttributeValue(java.lang.String additionalRenderedAttributeValue)

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.

setTooltipText

public void setTooltipText(java.lang.String tooltipText)

The tooltip text which will appear in the tooltip associated with the node

Parameters:

tooltipText - The tooltip text which will appear in the tooltip associated with the node

getRenderedText

public java.lang.String getRenderedText()

The rendered text. This will be used both in the Outliner and the Bread Crumb.

Returns:

Returns the rendered text. This will be used both in the Outliner and the Bread Crumb.

getAdditionalRenderedText

public java.lang.String 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

public java.lang.String 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.

getTooltipText

public java.lang.String getTooltipText()

The tooltip text which will appear in the tooltip associated with the node. The tooltip is not available on the Outliner on the Eclipse platform.

Returns:

the tooltip text which will appear in the tooltip associated with the node.

getNode

public AuthorNode getNode()

Returns:

Returns the node to render information for.

setIgnoreNodeFromDisplay

public void setIgnoreNodeFromDisplay(boolean ignoreNodeFromDisplay)

Set this to true to ignore this node from being displayed. This takes effect only on the Breadcrumb Customizer.

Parameters:

ignoreNodeFromDisplay - Set this to true to ignore this node from being displayed.

Since:

12.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

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.