com.aspose.words

Class GradientStopCollection

  • java.lang.Object
    • com.aspose.words.GradientStopCollection
  • All Implemented Interfaces:
    java.lang.Iterable
    public class GradientStopCollection 
    extends java.lang.Object

Contains a collection of GradientStop objects.
You do not create instances of this class directly. Use the Fill.GradientStops property to access gradient stops of fill objects.

Example:

Shows how to add gradient stops to the gradient fill.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Shape shape = builder.insertShape(ShapeType.RECTANGLE, 80.0, 80.0);
shape.getFill().twoColorGradient(Color.green, Color.RED, GradientStyle.HORIZONTAL, GradientVariant.VARIANT_2);

// Get gradient stops collection.
GradientStopCollection gradientStops = shape.getFill().getGradientStops();

// Change first gradient stop.
gradientStops.get(0).setColor(Color.yellow);
gradientStops.get(0).setPosition(0.1);
gradientStops.get(0).setTransparency(0.25);

// Add new gradient stop to the end of collection.
GradientStop gradientStop = new GradientStop(Color.blue, 0.5);
gradientStops.add(gradientStop);

// Remove gradient stop at index 1.
gradientStops.removeAt(1);
// And insert new gradient stop at the same index 1.
gradientStops.insert(1, new GradientStop(Color.pink, 0.75, 0.3));

// Remove last gradient stop in the collection.
gradientStop = gradientStops.get(2);
gradientStops.remove(gradientStop);

Assert.assertEquals(2, gradientStops.getCount());

Assert.assertEquals(Color.yellow.getRGB(), gradientStops.get(0).getColor().getRGB());
Assert.assertEquals(0.1d, gradientStops.get(0).getPosition(), 0.01d);
Assert.assertEquals(0.25d, gradientStops.get(0).getTransparency(), 0.01d);

Assert.assertEquals(Color.pink.getRGB(), gradientStops.get(1).getColor().getRGB());
Assert.assertEquals(0.75d, gradientStops.get(1).getPosition(), 0.01d);
Assert.assertEquals(0.3d, gradientStops.get(1).getTransparency(), 0.01d);

// Use the compliance option to define the shape using DML
// if you want to get "GradientStops" property after the document saves.
OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); }

doc.save(getArtifactsDir() + "Shape.GradientStops.docx", saveOptions);

Property Getters/Setters Summary
intgetCount()
Gets an integer value indicating the number of items in the collection.
GradientStopget(int index)
void
set(intindex, GradientStop value)
           Gets or sets a GradientStop object in the collection.
 
Method Summary
GradientStopadd(GradientStop gradientStop)
Adds a specified GradientStop to a gradient.
GradientStopinsert(int index, GradientStop gradientStop)
Inserts a GradientStop to the collection at a specified index.
java.util.Iterator<GradientStop>iterator()
Returns an enumerator that iterates through the collection.
booleanremove(GradientStop gradientStop)
Removes a specified GradientStop from the collection.
GradientStopremoveAt(int index)
Removes a GradientStop from the collection at a specified index.
 

    • Property Getters/Setters Detail

      • getCount

        public int getCount()
        
        Gets an integer value indicating the number of items in the collection.

        Example:

        Shows how to add gradient stops to the gradient fill.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Shape shape = builder.insertShape(ShapeType.RECTANGLE, 80.0, 80.0);
        shape.getFill().twoColorGradient(Color.green, Color.RED, GradientStyle.HORIZONTAL, GradientVariant.VARIANT_2);
        
        // Get gradient stops collection.
        GradientStopCollection gradientStops = shape.getFill().getGradientStops();
        
        // Change first gradient stop.
        gradientStops.get(0).setColor(Color.yellow);
        gradientStops.get(0).setPosition(0.1);
        gradientStops.get(0).setTransparency(0.25);
        
        // Add new gradient stop to the end of collection.
        GradientStop gradientStop = new GradientStop(Color.blue, 0.5);
        gradientStops.add(gradientStop);
        
        // Remove gradient stop at index 1.
        gradientStops.removeAt(1);
        // And insert new gradient stop at the same index 1.
        gradientStops.insert(1, new GradientStop(Color.pink, 0.75, 0.3));
        
        // Remove last gradient stop in the collection.
        gradientStop = gradientStops.get(2);
        gradientStops.remove(gradientStop);
        
        Assert.assertEquals(2, gradientStops.getCount());
        
        Assert.assertEquals(Color.yellow.getRGB(), gradientStops.get(0).getColor().getRGB());
        Assert.assertEquals(0.1d, gradientStops.get(0).getPosition(), 0.01d);
        Assert.assertEquals(0.25d, gradientStops.get(0).getTransparency(), 0.01d);
        
        Assert.assertEquals(Color.pink.getRGB(), gradientStops.get(1).getColor().getRGB());
        Assert.assertEquals(0.75d, gradientStops.get(1).getPosition(), 0.01d);
        Assert.assertEquals(0.3d, gradientStops.get(1).getTransparency(), 0.01d);
        
        // Use the compliance option to define the shape using DML
        // if you want to get "GradientStops" property after the document saves.
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); }
        
        doc.save(getArtifactsDir() + "Shape.GradientStops.docx", saveOptions);
      • get/set

        public GradientStop get(int index) / public void set(int index, GradientStop value)
        
        Gets or sets a GradientStop object in the collection.

        Example:

        Shows how to add gradient stops to the gradient fill.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Shape shape = builder.insertShape(ShapeType.RECTANGLE, 80.0, 80.0);
        shape.getFill().twoColorGradient(Color.green, Color.RED, GradientStyle.HORIZONTAL, GradientVariant.VARIANT_2);
        
        // Get gradient stops collection.
        GradientStopCollection gradientStops = shape.getFill().getGradientStops();
        
        // Change first gradient stop.
        gradientStops.get(0).setColor(Color.yellow);
        gradientStops.get(0).setPosition(0.1);
        gradientStops.get(0).setTransparency(0.25);
        
        // Add new gradient stop to the end of collection.
        GradientStop gradientStop = new GradientStop(Color.blue, 0.5);
        gradientStops.add(gradientStop);
        
        // Remove gradient stop at index 1.
        gradientStops.removeAt(1);
        // And insert new gradient stop at the same index 1.
        gradientStops.insert(1, new GradientStop(Color.pink, 0.75, 0.3));
        
        // Remove last gradient stop in the collection.
        gradientStop = gradientStops.get(2);
        gradientStops.remove(gradientStop);
        
        Assert.assertEquals(2, gradientStops.getCount());
        
        Assert.assertEquals(Color.yellow.getRGB(), gradientStops.get(0).getColor().getRGB());
        Assert.assertEquals(0.1d, gradientStops.get(0).getPosition(), 0.01d);
        Assert.assertEquals(0.25d, gradientStops.get(0).getTransparency(), 0.01d);
        
        Assert.assertEquals(Color.pink.getRGB(), gradientStops.get(1).getColor().getRGB());
        Assert.assertEquals(0.75d, gradientStops.get(1).getPosition(), 0.01d);
        Assert.assertEquals(0.3d, gradientStops.get(1).getTransparency(), 0.01d);
        
        // Use the compliance option to define the shape using DML
        // if you want to get "GradientStops" property after the document saves.
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); }
        
        doc.save(getArtifactsDir() + "Shape.GradientStops.docx", saveOptions);
    • Method Detail

      • add

        public GradientStop add(GradientStop gradientStop)
        Adds a specified GradientStop to a gradient.

        Example:

        Shows how to add gradient stops to the gradient fill.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Shape shape = builder.insertShape(ShapeType.RECTANGLE, 80.0, 80.0);
        shape.getFill().twoColorGradient(Color.green, Color.RED, GradientStyle.HORIZONTAL, GradientVariant.VARIANT_2);
        
        // Get gradient stops collection.
        GradientStopCollection gradientStops = shape.getFill().getGradientStops();
        
        // Change first gradient stop.
        gradientStops.get(0).setColor(Color.yellow);
        gradientStops.get(0).setPosition(0.1);
        gradientStops.get(0).setTransparency(0.25);
        
        // Add new gradient stop to the end of collection.
        GradientStop gradientStop = new GradientStop(Color.blue, 0.5);
        gradientStops.add(gradientStop);
        
        // Remove gradient stop at index 1.
        gradientStops.removeAt(1);
        // And insert new gradient stop at the same index 1.
        gradientStops.insert(1, new GradientStop(Color.pink, 0.75, 0.3));
        
        // Remove last gradient stop in the collection.
        gradientStop = gradientStops.get(2);
        gradientStops.remove(gradientStop);
        
        Assert.assertEquals(2, gradientStops.getCount());
        
        Assert.assertEquals(Color.yellow.getRGB(), gradientStops.get(0).getColor().getRGB());
        Assert.assertEquals(0.1d, gradientStops.get(0).getPosition(), 0.01d);
        Assert.assertEquals(0.25d, gradientStops.get(0).getTransparency(), 0.01d);
        
        Assert.assertEquals(Color.pink.getRGB(), gradientStops.get(1).getColor().getRGB());
        Assert.assertEquals(0.75d, gradientStops.get(1).getPosition(), 0.01d);
        Assert.assertEquals(0.3d, gradientStops.get(1).getTransparency(), 0.01d);
        
        // Use the compliance option to define the shape using DML
        // if you want to get "GradientStops" property after the document saves.
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); }
        
        doc.save(getArtifactsDir() + "Shape.GradientStops.docx", saveOptions);
      • insert

        public GradientStop insert(int index, GradientStop gradientStop)
        Inserts a GradientStop to the collection at a specified index.

        Example:

        Shows how to add gradient stops to the gradient fill.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Shape shape = builder.insertShape(ShapeType.RECTANGLE, 80.0, 80.0);
        shape.getFill().twoColorGradient(Color.green, Color.RED, GradientStyle.HORIZONTAL, GradientVariant.VARIANT_2);
        
        // Get gradient stops collection.
        GradientStopCollection gradientStops = shape.getFill().getGradientStops();
        
        // Change first gradient stop.
        gradientStops.get(0).setColor(Color.yellow);
        gradientStops.get(0).setPosition(0.1);
        gradientStops.get(0).setTransparency(0.25);
        
        // Add new gradient stop to the end of collection.
        GradientStop gradientStop = new GradientStop(Color.blue, 0.5);
        gradientStops.add(gradientStop);
        
        // Remove gradient stop at index 1.
        gradientStops.removeAt(1);
        // And insert new gradient stop at the same index 1.
        gradientStops.insert(1, new GradientStop(Color.pink, 0.75, 0.3));
        
        // Remove last gradient stop in the collection.
        gradientStop = gradientStops.get(2);
        gradientStops.remove(gradientStop);
        
        Assert.assertEquals(2, gradientStops.getCount());
        
        Assert.assertEquals(Color.yellow.getRGB(), gradientStops.get(0).getColor().getRGB());
        Assert.assertEquals(0.1d, gradientStops.get(0).getPosition(), 0.01d);
        Assert.assertEquals(0.25d, gradientStops.get(0).getTransparency(), 0.01d);
        
        Assert.assertEquals(Color.pink.getRGB(), gradientStops.get(1).getColor().getRGB());
        Assert.assertEquals(0.75d, gradientStops.get(1).getPosition(), 0.01d);
        Assert.assertEquals(0.3d, gradientStops.get(1).getTransparency(), 0.01d);
        
        // Use the compliance option to define the shape using DML
        // if you want to get "GradientStops" property after the document saves.
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); }
        
        doc.save(getArtifactsDir() + "Shape.GradientStops.docx", saveOptions);
      • iterator

        public java.util.Iterator<GradientStop> iterator()
        Returns an enumerator that iterates through the collection.
      • remove

        public boolean remove(GradientStop gradientStop)
        Removes a specified GradientStop from the collection.
        Returns:
        True if gradient stop was successfully removed, otherwise false.

        Example:

        Shows how to add gradient stops to the gradient fill.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Shape shape = builder.insertShape(ShapeType.RECTANGLE, 80.0, 80.0);
        shape.getFill().twoColorGradient(Color.green, Color.RED, GradientStyle.HORIZONTAL, GradientVariant.VARIANT_2);
        
        // Get gradient stops collection.
        GradientStopCollection gradientStops = shape.getFill().getGradientStops();
        
        // Change first gradient stop.
        gradientStops.get(0).setColor(Color.yellow);
        gradientStops.get(0).setPosition(0.1);
        gradientStops.get(0).setTransparency(0.25);
        
        // Add new gradient stop to the end of collection.
        GradientStop gradientStop = new GradientStop(Color.blue, 0.5);
        gradientStops.add(gradientStop);
        
        // Remove gradient stop at index 1.
        gradientStops.removeAt(1);
        // And insert new gradient stop at the same index 1.
        gradientStops.insert(1, new GradientStop(Color.pink, 0.75, 0.3));
        
        // Remove last gradient stop in the collection.
        gradientStop = gradientStops.get(2);
        gradientStops.remove(gradientStop);
        
        Assert.assertEquals(2, gradientStops.getCount());
        
        Assert.assertEquals(Color.yellow.getRGB(), gradientStops.get(0).getColor().getRGB());
        Assert.assertEquals(0.1d, gradientStops.get(0).getPosition(), 0.01d);
        Assert.assertEquals(0.25d, gradientStops.get(0).getTransparency(), 0.01d);
        
        Assert.assertEquals(Color.pink.getRGB(), gradientStops.get(1).getColor().getRGB());
        Assert.assertEquals(0.75d, gradientStops.get(1).getPosition(), 0.01d);
        Assert.assertEquals(0.3d, gradientStops.get(1).getTransparency(), 0.01d);
        
        // Use the compliance option to define the shape using DML
        // if you want to get "GradientStops" property after the document saves.
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); }
        
        doc.save(getArtifactsDir() + "Shape.GradientStops.docx", saveOptions);
      • removeAt

        public GradientStop removeAt(int index)
        Removes a GradientStop from the collection at a specified index.
        Returns:
        Removed GradientStop.

        Example:

        Shows how to add gradient stops to the gradient fill.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Shape shape = builder.insertShape(ShapeType.RECTANGLE, 80.0, 80.0);
        shape.getFill().twoColorGradient(Color.green, Color.RED, GradientStyle.HORIZONTAL, GradientVariant.VARIANT_2);
        
        // Get gradient stops collection.
        GradientStopCollection gradientStops = shape.getFill().getGradientStops();
        
        // Change first gradient stop.
        gradientStops.get(0).setColor(Color.yellow);
        gradientStops.get(0).setPosition(0.1);
        gradientStops.get(0).setTransparency(0.25);
        
        // Add new gradient stop to the end of collection.
        GradientStop gradientStop = new GradientStop(Color.blue, 0.5);
        gradientStops.add(gradientStop);
        
        // Remove gradient stop at index 1.
        gradientStops.removeAt(1);
        // And insert new gradient stop at the same index 1.
        gradientStops.insert(1, new GradientStop(Color.pink, 0.75, 0.3));
        
        // Remove last gradient stop in the collection.
        gradientStop = gradientStops.get(2);
        gradientStops.remove(gradientStop);
        
        Assert.assertEquals(2, gradientStops.getCount());
        
        Assert.assertEquals(Color.yellow.getRGB(), gradientStops.get(0).getColor().getRGB());
        Assert.assertEquals(0.1d, gradientStops.get(0).getPosition(), 0.01d);
        Assert.assertEquals(0.25d, gradientStops.get(0).getTransparency(), 0.01d);
        
        Assert.assertEquals(Color.pink.getRGB(), gradientStops.get(1).getColor().getRGB());
        Assert.assertEquals(0.75d, gradientStops.get(1).getPosition(), 0.01d);
        Assert.assertEquals(0.3d, gradientStops.get(1).getTransparency(), 0.01d);
        
        // Use the compliance option to define the shape using DML
        // if you want to get "GradientStops" property after the document saves.
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); }
        
        doc.save(getArtifactsDir() + "Shape.GradientStops.docx", saveOptions);