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

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

public class RenderingInformation
extends Object

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

*********************************
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.

Since:

11.2

Constructor Summary

RenderingInformation(AuthorNode node, String renderedText, String additionalRenderedText, String tooltipText)

Method Summary

String	getAdditionalRenderedText() The additional rendered text.
AuthorNode	getNode()
String	getRenderedText() The rendered text.
String	getTooltipText() The tooltip text which will appear in the tooltip associated with the node.
void	setAdditionalRenderedText(String additionalRenderedText) The additional rendered text.
void	setRenderedText(String renderedText) The rendered text.
void	setTooltipText(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,
                            String renderedText,
                            String additionalRenderedText,
                            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 the value of the first attribute and some text.

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

Method Detail

setRenderedText

public void setRenderedText(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(String additionalRenderedText)

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.

Parameters:

additionalRenderedText - 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.

setTooltipText

public void setTooltipText(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 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 String getAdditionalRenderedText()

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.

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.

getTooltipText

public 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.