com.aspose.slides

Interfaces

Classes

Exceptions

Skip navigation links
com.aspose.slides

Class Portion

  • java.lang.Object
    • com.aspose.slides.Portion

    • Constructor Summary

      Constructors 
      Constructor and Description
      Portion()
      Initializes a new instance of the Portion class.
      Portion(Portion portion)
      Initializes a new instance of the Portion class.
      Portion(java.lang.String str)
      Initializes a new instance of the Portion class.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      void addField(IFieldType fieldType)
      Converts this portion to the automaticaly updated field.
      void addField(java.lang.String internalString)
      Converts this portion to the automaticaly updated field.
      IPortionFormatEffectiveData createPortionFormatEffective()
      Deprecated. 
      Use Portion.PortionFormat.GetEffective() instead. The method will be removed after release of version 20.8.
      java.awt.geom.Point2D.Float getCoordinates()
      Get coordinates of the beginning of the portion.
      IField getField()
      Returns a field of this portion.
      com.aspose.slides.IDOMObject getParent_Immediate()
      Returns Parent_Immediate object.
      IPortionFormat getPortionFormat()
      Returns oformatting bject which contains explicitly set formatting properties of the text portion with no inheritance applied.
      IPresentation getPresentation()
      Returns the parent presentation of a text.
      java.awt.geom.Rectangle2D.Float getRect()
      Get coordinates of rect that bounds portion.
      IBaseSlide getSlide()
      Returns the parent slide of a text.
      java.lang.String getText()
      Gets or sets the plain text of a portion.
      void removeField()
      Converts this field portion to the simple portion.
      void setText(java.lang.String value)
      Gets or sets the plain text of a portion.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Portion

        public Portion()

        Initializes a new instance of the Portion class.

      • Portion

        public Portion(java.lang.String str)

        Initializes a new instance of the Portion class.

      • Portion

        public Portion(Portion portion)

        Initializes a new instance of the Portion class.

    • Method Detail

      • getPortionFormat

        public final IPortionFormat getPortionFormat()

        Returns oformatting bject which contains explicitly set formatting properties of the text portion with no inheritance applied. Read-only IPortionFormat.

        The formatting object contains the formatting parameters defined for the current portion only, inherited data is not applied.

        In order to get the effective values including inherited ones use the PortionFormat.getEffective() method.

        Specified by:
        getPortionFormat in interface IPortion

      • createPortionFormatEffective

        @Deprecated
public final IPortionFormatEffectiveData createPortionFormatEffective()
        Deprecated. Use Portion.PortionFormat.GetEffective() instead. The method will be removed after release of version 20.8.

        Creates and returns PortionFormatEffectiveData object which contains current portion formatting properties, including inherited.

        Specified by:
        createPortionFormatEffective in interface IPortion
        Returns:
        A PortionFormatEffectiveData instance.

      • getText

        public final java.lang.String getText()

        Gets or sets the plain text of a portion. Read/write String.

        Value: The text.
        Specified by:
        getText in interface IPortion

      • setText

        public final void setText(java.lang.String value)

        Gets or sets the plain text of a portion. Read/write String.

        Value: The text.
        Specified by:
        setText in interface IPortion

      • getField

        public final IField getField()

        Returns a field of this portion. Read-only IField.

        Specified by:
        getField in interface IPortion

      • addField

        public final void addField(IFieldType fieldType)

        Converts this portion to the automaticaly updated field.

        Specified by:
        addField in interface IPortion

      • addField

        public final void addField(java.lang.String internalString)

        Converts this portion to the automaticaly updated field.

        Specified by:
        addField in interface IPortion
        Parameters:
        internalString - Internal name of FieldType.

      • removeField

        public final void removeField()

        Converts this field portion to the simple portion.

        Specified by:
        removeField in interface IPortion

      • getRect

        public final java.awt.geom.Rectangle2D.Float getRect()

        Get coordinates of rect that bounds portion. The rect includes all the lines of text in portion, including empty ones. 

        Example:
 
         Presentation pres = new Presentation();
 try
 {
        ISlide slide = pres.getSlides().get_Item(0);
        IAutoShape shape = slide.getShapes().addAutoShape(ShapeType.Rectangle, 50, 50, 200, 50);
        shape.getTextFrame().getParagraphs().get_Item(0).getPortions().clear();
        Portion portion0 = new Portion("Some text");
        Portion portion1 = new Portion("GetRect text");
        shape.getTextFrame().getParagraphs().get_Item(0).getPortions().add(portion0);
        shape.getTextFrame().getParagraphs().get_Item(0).getPortions().add(portion1);
        Rectangle2D.Float rect = shape.getTextFrame().getParagraphs().get_Item(0).getPortions().get_Item(1).getRect();
        ...
 } finally {
        if (pres != null) pres.dispose();
 }
        Specified by:
        getRect in interface IPortion

      • getCoordinates

        public final java.awt.geom.Point2D.Float getCoordinates()

        Get coordinates of the beginning of the portion. The X coordinate of point represents the portion beginning from the first character including left side bearing. The Y coordinate includes top side bearing.

        Specified by:
        getCoordinates in interface IPortion

      • getParent_Immediate

        public final com.aspose.slides.IDOMObject getParent_Immediate()

        Returns Parent_Immediate object. Read-only IDOMObject.