Interface TextAnnotation

All Superinterfaces:
Annotation

public interface TextAnnotation extends Annotation
A text annotation is a simple text string that is displayed on the network canvas. The text may be rendered using different colors and styles, but at this point, the colors and styles of the text may not be varied within the string.

Module: presentation-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>presentation-api</artifactId>
</dependency>

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.
  • Field Details

  • Method Details

    • setText

      void setText(String text)
      Set the text to be displayed as part of the annotation
      Parameters:
      text - the text annotation
    • getText

      String getText()
      Get the text to be displayed as part of the annotation
      Returns:
      the text annotation
    • setTextColor

      void setTextColor(Color color)
      Set the color of the text to be displayed
      Parameters:
      color - the text color
    • getTextColor

      Color getTextColor()
      Get the color of the text to be displayed
      Returns:
      the text annotation
    • setFontSize

      void setFontSize(double size)
      Set the size of the font used to display the text
      Parameters:
      size - the size of the font
    • getFontSize

      double getFontSize()
      Get the size of the font used to display the text
      Returns:
      the font size
    • setFontStyle

      void setFontStyle(int style)
      Set the font style
      Parameters:
      style - the font style
    • getFontStyle

      int getFontStyle()
      Get the font style
      Returns:
      the font style
    • setFontFamily

      void setFontFamily(String family)
      Set the font family to be used for the text display
      Parameters:
      family - the font family to use
    • getFontFamily

      String getFontFamily()
      Get the font family to be used for the text display
      Returns:
      the font family to use
    • getFont

      Font getFont()
      Get the font being used
      Returns:
      the font being used
    • setFont

      void setFont(Font font)
      Set the font to be used. Note that this will override the existing settings for font style, size, and family
      Parameters:
      font - the text font to use