com.esri.arcgis.display
Interface IDisplayTransformationScales

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
DisplayTransformation, IDisplayTransformationScalesProxy

public interface IDisplayTransformationScales
extends java.io.Serializable

COM Interface 'IDisplayTransformationScales'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description: 'Provides access to members that control Display Transformation scales.' 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 IIDa709b584_9fb9_4954_8096_02068c16a677
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addUserScale(double scale)
          Add a new user scale.
 double calculateScale(IEnvelope extent)
          Calculate the scale of the specified extent.
 int getScaleSnapping()
          Indicates if transform snaps the fitted bounds to a standard scale.
 double getUserScale(int idx)
          Get the user scales.
 int getUserScaleCount()
          Get the number of user scales.
 void loadDefaultUserScales()
          Initialize user scales to defaults.
 double nextScale(double scale)
          Find the nearest standard scale with a value that is higher than the specified scale.
 double previousScale(double scale)
          Find the nearest standard scale with a value that is lower than the specified scale.
 void removeAllUserScales()
          Remove all the user scales.
 void removeUserScale(double scale)
          Remove a user scale.
 void saveDefaultUserScales()
          Set the current set of user scales to be the defaults.
 void setScaleSnapping(int setting)
          Indicates if transform snaps the fitted bounds to a standard scale.
 double snapScale(double scale)
          Snap the specified scale to a standard scale.
 void zoomTo(IEnvelope extent, double scale)
          Zoom to the specified scale.
 

Field Detail

IIDa709b584_9fb9_4954_8096_02068c16a677

static final int IIDa709b584_9fb9_4954_8096_02068c16a677
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

getScaleSnapping

int getScaleSnapping()
                     throws java.io.IOException,
                            AutomationException
Indicates if transform snaps the fitted bounds to a standard scale.

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

setScaleSnapping

void setScaleSnapping(int setting)
                      throws java.io.IOException,
                             AutomationException
Indicates if transform snaps the fitted bounds to a standard scale.

Parameters:
setting - A com.esri.arcgis.display.esriScaleSnapping constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUserScaleCount

int getUserScaleCount()
                      throws java.io.IOException,
                             AutomationException
Get the number of user scales.

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

getUserScale

double getUserScale(int idx)
                    throws java.io.IOException,
                           AutomationException
Get the user scales.

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

addUserScale

void addUserScale(double scale)
                  throws java.io.IOException,
                         AutomationException
Add a new user scale.

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

removeUserScale

void removeUserScale(double scale)
                     throws java.io.IOException,
                            AutomationException
Remove a user scale.

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

removeAllUserScales

void removeAllUserScales()
                         throws java.io.IOException,
                                AutomationException
Remove all the user scales.

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

loadDefaultUserScales

void loadDefaultUserScales()
                           throws java.io.IOException,
                                  AutomationException
Initialize user scales to defaults.

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

saveDefaultUserScales

void saveDefaultUserScales()
                           throws java.io.IOException,
                                  AutomationException
Set the current set of user scales to be the defaults.

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

calculateScale

double calculateScale(IEnvelope extent)
                      throws java.io.IOException,
                             AutomationException
Calculate the scale of the specified extent.

Parameters:
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Returns:
The scale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomTo

void zoomTo(IEnvelope extent,
            double scale)
            throws java.io.IOException,
                   AutomationException
Zoom to the specified scale. Center on extent.

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

snapScale

double snapScale(double scale)
                 throws java.io.IOException,
                        AutomationException
Snap the specified scale to a standard scale.

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

nextScale

double nextScale(double scale)
                 throws java.io.IOException,
                        AutomationException
Find the nearest standard scale with a value that is higher than the specified scale.

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

previousScale

double previousScale(double scale)
                     throws java.io.IOException,
                            AutomationException
Find the nearest standard scale with a value that is lower than the specified scale.

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