com.esri.arcgis.carto
Interface IFrameDecoration

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IFrameDecorationProxy, SymbolBackground, SymbolBorder, SymbolShadow

public interface IFrameDecoration
extends java.io.Serializable

COM Interface 'IFrameDecoration'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control frame decorations.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID6a75a961_36fc_44a9_8baf_30195de20c58
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void draw(IDisplay display, IGeometry geometry)
          Draws the decoration into the given display object.
 IColor getColor()
          Color of the frame decoration.
 short getCornerRounding()
          Amount of corner rounding.
 IGeometry getGeometry(IDisplay display, IGeometry shape)
          Geometry used to draw the decoration.
 double getHorizontalSpacing()
          Horizontal offset or gap between the decoration and the subject in points.
 java.lang.String getName()
          Name of the frame decoration.
 double getVerticalSpacing()
          Vertical offset or gap between the decoration 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 setColor(IColor color)
          Color of the frame decoration.
 void setCornerRounding(short rounding)
          Amount of corner rounding.
 void setHorizontalSpacing(double points)
          Horizontal offset or gap between the decoration and the subject in points.
 void setName(java.lang.String name)
          Name of the frame decoration.
 void setVerticalSpacing(double points)
          Vertical offset or gap between the decoration and the subject in points.
 

Field Detail

IID6a75a961_36fc_44a9_8baf_30195de20c58

static final int IID6a75a961_36fc_44a9_8baf_30195de20c58
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the frame decoration.

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

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Name of the frame decoration.

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

getColor

IColor getColor()
                throws java.io.IOException,
                       AutomationException
Color of the frame decoration.

Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColor

void setColor(IColor color)
              throws java.io.IOException,
                     AutomationException
Color of the frame decoration.

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

getHorizontalSpacing

double getHorizontalSpacing()
                            throws java.io.IOException,
                                   AutomationException
Horizontal offset or gap between the decoration and the subject in points.

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

setHorizontalSpacing

void setHorizontalSpacing(double points)
                          throws java.io.IOException,
                                 AutomationException
Horizontal offset or gap between the decoration and the subject in points.

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

getVerticalSpacing

double getVerticalSpacing()
                          throws java.io.IOException,
                                 AutomationException
Vertical offset or gap between the decoration and the subject in points.

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

setVerticalSpacing

void setVerticalSpacing(double points)
                        throws java.io.IOException,
                               AutomationException
Vertical offset or gap between the decoration and the subject in points.

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

getCornerRounding

short getCornerRounding()
                        throws java.io.IOException,
                               AutomationException
Amount of corner rounding. 0 = fully square. 100 = fully round.

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

setCornerRounding

void setCornerRounding(short rounding)
                       throws java.io.IOException,
                              AutomationException
Amount of corner rounding. 0 = fully square. 100 = fully round.

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

queryBounds

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry(IDisplay display,
                      IGeometry shape)
                      throws java.io.IOException,
                             AutomationException
Geometry used to draw the decoration.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          IGeometry geometry)
          throws java.io.IOException,
                 AutomationException
Draws the decoration into the given display object.

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