com.aspose.slides

Class EffectFormat

java.lang.Object

com.aspose.slides.PVIObject

com.aspose.slides.EffectFormat

All Implemented Interfaces:

IEffectFormat, IEffectParamSource, IPresentationComponent, ISlideComponent

public final class EffectFormat
extends PVIObject
implements IEffectFormat

Represents effect properties of shape.

Method Summary

Modifier and Type	Method and Description
void	disableBlurEffect() Disables blur effect.
void	disableFillOverlayEffect() Disables fill overlay effect.
void	disableGlowEffect() Disable glow effect.
void	disableInnerShadowEffect() Disables inner shadow effect.
void	disableOuterShadowEffect() Disables outer shadow effect.
void	disablePresetShadowEffect() Disables preset shadow effect.
void	disableReflectionEffect() Disables reflection effect.
void	disableSoftEdgeEffect() Disables soft edge effect.
void	enableFillOverlayEffect() Enables fill overlay effect.
void	enableGlowEffect() Enables glow effect.
void	enableInnerShadowEffect() Enables inner shadow effect.
void	enableOuterShadowEffect() Enables outer shadow effect.
void	enablePresetShadowEffect() Enables preset shadows effect.
void	enableReflectionEffect() Enables reflection effect.
void	enableSoftEdgeEffect() Enables soft edge effect.
IBlur	getBlurEffect() Blur effect.
IEffectFormatEffectiveData	getEffective() Gets effective effect formatting data with the inheritance applied.
IFillOverlay	getFillOverlayEffect() Fill overlay effect.
IGlow	getGlowEffect() Glow effect.
IInnerShadow	getInnerShadowEffect() Inner shadow.
IOuterShadow	getOuterShadowEffect() Outer shadow.
IPresetShadow	getPresetShadowEffect() Preset shadow.
IReflection	getReflectionEffect() Reflection.
ISoftEdge	getSoftEdgeEffect() Soft edge.
long	getVersion() Version.
boolean	isNoEffects() Returns true if all effects are disabled (as just created, default EffectFormat object).
void	setBlurEffect(double radius, boolean grow) Sets blur effect.
void	setBlurEffect(IBlur value) Blur effect.
void	setFillOverlayEffect(IFillOverlay value) Fill overlay effect.
void	setGlowEffect(IGlow value) Glow effect.
void	setInnerShadowEffect(IInnerShadow value) Inner shadow.
void	setOuterShadowEffect(IOuterShadow value) Outer shadow.
void	setPresetShadowEffect(IPresetShadow value) Preset shadow.
void	setReflectionEffect(IReflection value) Reflection.
void	setSoftEdgeEffect(ISoftEdge value) Soft edge.

Methods inherited from class com.aspose.slides.PVIObject

equals, getParent_Immediate, getParent_IPresentationComponent, getParent_ISlideComponent, getPresentation, getSlide, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVersion

public long getVersion()

Version. Read-only long.

Overrides:

getVersion in class PVIObject

isNoEffects

public final boolean isNoEffects()

Returns true if all effects are disabled (as just created, default EffectFormat object). Read-only boolean.

Specified by:

isNoEffects in interface IEffectFormat

getBlurEffect

public final IBlur getBlurEffect()

Blur effect. Read/write IBlur.

Specified by:

getBlurEffect in interface IEffectFormat

setBlurEffect

public final void setBlurEffect(IBlur value)

Blur effect. Read/write IBlur.

Specified by:

setBlurEffect in interface IEffectFormat

getFillOverlayEffect

public final IFillOverlay getFillOverlayEffect()

Fill overlay effect. Read/write IFillOverlay.

Specified by:

getFillOverlayEffect in interface IEffectFormat

setFillOverlayEffect

public final void setFillOverlayEffect(IFillOverlay value)

Fill overlay effect. Read/write IFillOverlay.

Specified by:

setFillOverlayEffect in interface IEffectFormat

getGlowEffect

public final IGlow getGlowEffect()

Glow effect. Read/write IGlow.

Specified by:

getGlowEffect in interface IEffectFormat

setGlowEffect

public final void setGlowEffect(IGlow value)

Glow effect. Read/write IGlow.

Specified by:

setGlowEffect in interface IEffectFormat

getInnerShadowEffect

public final IInnerShadow getInnerShadowEffect()

Inner shadow. Read/write IInnerShadow.

Specified by:

getInnerShadowEffect in interface IEffectFormat

setInnerShadowEffect

public final void setInnerShadowEffect(IInnerShadow value)

Inner shadow. Read/write IInnerShadow.

Specified by:

setInnerShadowEffect in interface IEffectFormat

getOuterShadowEffect

public final IOuterShadow getOuterShadowEffect()

Outer shadow. Read/write IOuterShadow.

Specified by:

getOuterShadowEffect in interface IEffectFormat

setOuterShadowEffect

public final void setOuterShadowEffect(IOuterShadow value)

Outer shadow. Read/write IOuterShadow.

Specified by:

setOuterShadowEffect in interface IEffectFormat

getPresetShadowEffect

public final IPresetShadow getPresetShadowEffect()

Preset shadow. Read/write IPresetShadow.

Specified by:

getPresetShadowEffect in interface IEffectFormat

setPresetShadowEffect

public final void setPresetShadowEffect(IPresetShadow value)

Preset shadow. Read/write IPresetShadow.

Specified by:

setPresetShadowEffect in interface IEffectFormat

getReflectionEffect

public final IReflection getReflectionEffect()

Reflection. Read/write IReflection.

Specified by:

getReflectionEffect in interface IEffectFormat

setReflectionEffect

public final void setReflectionEffect(IReflection value)

Reflection. Read/write IReflection.

Specified by:

setReflectionEffect in interface IEffectFormat

getSoftEdgeEffect

public final ISoftEdge getSoftEdgeEffect()

Soft edge. Read/write ISoftEdge.

Specified by:

getSoftEdgeEffect in interface IEffectFormat

setSoftEdgeEffect

public final void setSoftEdgeEffect(ISoftEdge value)

Soft edge. Read/write ISoftEdge.

Specified by:

setSoftEdgeEffect in interface IEffectFormat

setBlurEffect

public final void setBlurEffect(double radius,
                                boolean grow)

Sets blur effect.

Specified by:

setBlurEffect in interface IEffectFormat

Parameters:

radius - Radius.

grow - Grow.

enableFillOverlayEffect

public final void enableFillOverlayEffect()

Enables fill overlay effect.

Specified by:

enableFillOverlayEffect in interface IEffectFormat

enableGlowEffect

public final void enableGlowEffect()

Enables glow effect.

Specified by:

enableGlowEffect in interface IEffectFormat

enableInnerShadowEffect

public final void enableInnerShadowEffect()

Enables inner shadow effect.

Specified by:

enableInnerShadowEffect in interface IEffectFormat

enableOuterShadowEffect

public final void enableOuterShadowEffect()

Enables outer shadow effect.

Specified by:

enableOuterShadowEffect in interface IEffectFormat

enablePresetShadowEffect

public final void enablePresetShadowEffect()

Enables preset shadows effect.

Specified by:

enablePresetShadowEffect in interface IEffectFormat

enableReflectionEffect

public final void enableReflectionEffect()

Enables reflection effect.

Specified by:

enableReflectionEffect in interface IEffectFormat

enableSoftEdgeEffect

public final void enableSoftEdgeEffect()

Enables soft edge effect.

Specified by:

enableSoftEdgeEffect in interface IEffectFormat

disableBlurEffect

public final void disableBlurEffect()

Disables blur effect.

Specified by:

disableBlurEffect in interface IEffectFormat

disableFillOverlayEffect

public final void disableFillOverlayEffect()

Disables fill overlay effect.

Specified by:

disableFillOverlayEffect in interface IEffectFormat

disableGlowEffect

public final void disableGlowEffect()

Disable glow effect.

Specified by:

disableGlowEffect in interface IEffectFormat

disableInnerShadowEffect

public final void disableInnerShadowEffect()

Disables inner shadow effect.

Specified by:

disableInnerShadowEffect in interface IEffectFormat

disableOuterShadowEffect

public final void disableOuterShadowEffect()

Disables outer shadow effect.

Specified by:

disableOuterShadowEffect in interface IEffectFormat

disablePresetShadowEffect

public final void disablePresetShadowEffect()

Disables preset shadow effect.

Specified by:

disablePresetShadowEffect in interface IEffectFormat

disableReflectionEffect

public final void disableReflectionEffect()

Disables reflection effect.

Specified by:

disableReflectionEffect in interface IEffectFormat

disableSoftEdgeEffect

public final void disableSoftEdgeEffect()

Disables soft edge effect.

Specified by:

disableSoftEdgeEffect in interface IEffectFormat

getEffective

public final IEffectFormatEffectiveData getEffective()

Gets effective effect formatting data with the inheritance applied.

 This example demonstrates getting some of shape's effective effect properties.
 
 Presentation pres = new Presentation("MyPresentation.pptx");
 try
 {
        IEffectFormatEffectiveData effectiveEffectFormat = pres.getSlides().get_Item(0).Shapes().get_Item(0).getEffectFormat().getEffective();
        if (effectiveEffectFormat.isNoEffects())
        {
                System.out.println("The shape has not effects applied.");
        }
        else
        {
                if (effectiveEffectFormat.getBlurEffect() != null)
                        System.out.println("Blur effect radius: " + effectiveEffectFormat.getBlurEffect().getRadius());
                if (effectiveEffectFormat.getFillOverlayEffect() != null)
                        System.out.println("Fill overlay effect fill type: " + effectiveEffectFormat.getFillOverlayEffect().getFillFormat().getFillType());
                if (effectiveEffectFormat.getGlowEffect() != null)
                        System.out.println("Glow effect color: " + effectiveEffectFormat.getGlowEffect().getColor());
                if (effectiveEffectFormat.getInnerShadowEffect() != null)
                        System.out.println("Inner shadow effect shadow color: " + effectiveEffectFormat.getInnerShadowEffect().getShadowColor());
                if (effectiveEffectFormat.getOuterShadowEffect() != null)
                        System.out.println("Outer shadow effect shadow color: " + effectiveEffectFormat.getOuterShadowEffect().getShadowColor());
                if (effectiveEffectFormat.getPresetShadowEffect() != null)
                        System.out.println("Preset shadow effect shadow color: " + effectiveEffectFormat.getPresetShadowEffect().getShadowColor());
                if (effectiveEffectFormat.getReflectionEffect() != null)
                        System.out.println("Reflection effect distance: " + effectiveEffectFormat.getReflectionEffect().getDistance());
                if (effectiveEffectFormat.getSoftEdgeEffect() != null)
                        System.out.println("Soft edge effect radius: " + effectiveEffectFormat.getSoftEdgeEffect().getRadius());
        }
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getEffective in interface IEffectFormat

Returns:

A IEffectFormatEffectiveData.