|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.cartographytools.FeatureOutlineMasks
public class FeatureOutlineMasks
Creates mask polygons at a specified distance and shape around the symbolized features in the input layer. The Feature Outline Masks tool is contained in the Cartography Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
FeatureOutlineMasks()
Creates the Feature Outline Masks tool with defaults. |
|
FeatureOutlineMasks(Object inputLayer,
Object outputFc,
double referenceScale,
Object spatialReference,
Object margin,
String method,
String maskForNonPlacedAnno)
Creates the Feature Outline Masks tool with the required parameters. |
Method Summary | |
---|---|
String |
getAttributes()
Returns the Transfer Attributes parameter of this tool . |
Object |
getInputLayer()
Returns the Input Layer parameter of this tool . |
Object |
getMargin()
Returns the Margin parameter of this tool . |
String |
getMaskForNonPlacedAnno()
Returns the Create masks for unplaced annotation. |
String |
getMethod()
Returns the Mask Kind parameter of this tool . |
Object |
getOutputFc()
Returns the Output Feature Class parameter of this tool . |
double |
getReferenceScale()
Returns the Reference Scale parameter of this tool . |
Object |
getSpatialReference()
Returns the Calculation coordinate system parameter of this tool . |
String |
getToolboxAlias()
Returns the alias of the tool box containing this tool. |
String |
getToolboxName()
Returns the name of the tool box containing this tool. |
String |
getToolName()
Returns the name of this tool. |
void |
setAttributes(String attributes)
Sets the Transfer Attributes parameter of this tool . |
void |
setInputLayer(Object inputLayer)
Sets the Input Layer parameter of this tool . |
void |
setMargin(Object margin)
Sets the Margin parameter of this tool . |
void |
setMaskForNonPlacedAnno(String maskForNonPlacedAnno)
Sets the Create masks for unplaced annotation. |
void |
setMethod(String method)
Sets the Mask Kind parameter of this tool . |
void |
setOutputFc(Object outputFc)
Sets the Output Feature Class parameter of this tool . |
void |
setReferenceScale(double referenceScale)
Sets the Reference Scale parameter of this tool . |
void |
setSpatialReference(Object spatialReference)
Sets the Calculation coordinate system parameter of this tool . |
Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
getParameterValues, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FeatureOutlineMasks()
Initializes the array of tool parameters with the default values specified when the tool was created.
public FeatureOutlineMasks(Object inputLayer, Object outputFc, double referenceScale, Object spatialReference, Object margin, String method, String maskForNonPlacedAnno)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inputLayer
- the symbolized input layer from which the masks will be created.outputFc
- the feature class that will contain the mask features.referenceScale
- the reference scale used for calculating the masking geometry when masks are specified in page units. This is typically the reference scale of the map.spatialReference
- the spatial reference for which the masking polygons will be created. This is not the spatial reference that will be assigned to the output feature class. It is the spatial reference of the map in which the masking polygons will be used since the position of symbology may change when features are projected.margin
- the space in page units surrounding the symbolized input features used to create the mask polygon. Typically, masking polygons are created with a small margin around the symbol to improve visual appearance. Margin values are specified in either page units or map units. Most of the time you will want to specify your margin distance value in page units. margin value units are interpreted differently depending on which units you choose. If you choose points, inches, millimeters, or centimeters, then masks are created using the margin distance as calculated in page space (you can think of the margin as a distance measured on the paper). The reference scale parameter value is accounted for in this calculation. if you choose any other units for your margin, then masks are created using the margin distance as calculated in map space (you can think of the margin as a real-world distance measure on the earth). Also, in this case, the reference scale parameter value is not used as part of the calculation.method
- the type of masking geometry created. There are four types:maskForNonPlacedAnno
- specifies whether to create masks for unplaced annotation. This option is only used when masking geodatabase annotation layers.Method Detail |
---|
public Object getInputLayer()
public void setInputLayer(Object inputLayer)
inputLayer
- the symbolized input layer from which the masks will be created.public Object getOutputFc()
public void setOutputFc(Object outputFc)
outputFc
- the feature class that will contain the mask features.public double getReferenceScale()
public void setReferenceScale(double referenceScale)
referenceScale
- the reference scale used for calculating the masking geometry when masks are specified in page units. This is typically the reference scale of the map.public Object getSpatialReference()
public void setSpatialReference(Object spatialReference)
spatialReference
- the spatial reference for which the masking polygons will be created. This is not the spatial reference that will be assigned to the output feature class. It is the spatial reference of the map in which the masking polygons will be used since the position of symbology may change when features are projected.public Object getMargin()
public void setMargin(Object margin)
margin
- the space in page units surrounding the symbolized input features used to create the mask polygon. Typically, masking polygons are created with a small margin around the symbol to improve visual appearance. Margin values are specified in either page units or map units. Most of the time you will want to specify your margin distance value in page units. margin value units are interpreted differently depending on which units you choose. If you choose points, inches, millimeters, or centimeters, then masks are created using the margin distance as calculated in page space (you can think of the margin as a distance measured on the paper). The reference scale parameter value is accounted for in this calculation. if you choose any other units for your margin, then masks are created using the margin distance as calculated in map space (you can think of the margin as a real-world distance measure on the earth). Also, in this case, the reference scale parameter value is not used as part of the calculation.public String getMethod()
public void setMethod(String method)
method
- the type of masking geometry created. There are four types:public String getMaskForNonPlacedAnno()
public void setMaskForNonPlacedAnno(String maskForNonPlacedAnno)
maskForNonPlacedAnno
- specifies whether to create masks for unplaced annotation. This option is only used when masking geodatabase annotation layers.public String getAttributes()
public void setAttributes(String attributes)
attributes
- determines which attributes will be transferred from the input features to the output features.public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |