com.esri.arcgis.carto
Interface IShadow

All Superinterfaces:
Serializable
All Known Subinterfaces:
ISymbolShadow
All Known Implementing Classes:
SymbolShadow

public interface IShadow
extends Serializable

Provides access to members that control frame drop shadows.

Remarks

The SymbolShadow object is used to draw drop shadows around frame elements.

IShadow is used to manage drop shadows properties such as HorizontalSpacing and VerticalSpacing determining the distance between the shadow and the frame. The Name property defines the name of the SymbolShadow as listed in the shadow selector. GetGeometry will return the geometry of the drop shadow. The QueryBounds and Draw methods are equivalent to the similar methods of IElement.

See ISymbolShadow for additional control of the drop shadow.

See also IFrameDecoration.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void draw(IDisplay display, IGeometry geometry)
          Draws the drop shadow into the given display object.
 IGeometry getGeometry(IDisplay display, IGeometry shape)
          Geometry used to draw the drop shadow.
 double getHorizontalSpacing()
          Horizontal offset between the drop shadow and the subject in points.
 String getName()
          Name of the drop shadow.
 double getVerticalSpacing()
          Vertical offset between the drop shadow and the subject in points.
 void queryBounds(IDisplay display, IGeometry geometry, IEnvelope bounds)
          Bounding rectangle of the geometry including the area covered by the border.
 void setHorizontalSpacing(double points)
          Horizontal offset between the drop shadow and the subject in points.
 void setName(String name)
          Name of the drop shadow.
 void setVerticalSpacing(double points)
          Vertical offset between the drop shadow and the subject in points.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the drop shadow.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException
Name of the drop shadow.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHorizontalSpacing

double getHorizontalSpacing()
                            throws IOException,
                                   AutomationException
Horizontal offset between the drop shadow and the subject in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The points
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHorizontalSpacing

void setHorizontalSpacing(double points)
                          throws IOException,
                                 AutomationException
Horizontal offset between the drop shadow and the subject in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
points - The points (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVerticalSpacing

double getVerticalSpacing()
                          throws IOException,
                                 AutomationException
Vertical offset between the drop shadow and the subject in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The points
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVerticalSpacing

void setVerticalSpacing(double points)
                        throws IOException,
                               AutomationException
Vertical offset between the drop shadow and the subject in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
points - The points (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryBounds

void queryBounds(IDisplay display,
                 IGeometry geometry,
                 IEnvelope bounds)
                 throws IOException,
                        AutomationException
Bounding rectangle of the geometry including the area covered by the border.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry(IDisplay display,
                      IGeometry shape)
                      throws IOException,
                             AutomationException
Geometry used to draw the drop shadow.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          IGeometry geometry)
          throws IOException,
                 AutomationException
Draws the drop shadow into the given display object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.