Class 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 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

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