SchematicLayer (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.schematic
Class SchematicLayer

java.lang.Object
  com.esri.arcgis.schematic.SchematicLayer

All Implemented Interfaces:: ICompositeLayer, ICompositeLayer2, IDataLayer, IDataLayer2, IFeatureLayerSelectionEvents, IIdentify, IIdentify2, ILayer, ILayer2, ILayerDrawingProperties, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILayerSymbologyExtents, IPublishLayer, ISymbolLevels, ITemporaryLayer, IMapLevel, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, ISchematicLayer, ISchematicLayerEditHelper, ISchematicLayerTemplate, IPersist, IPersistStream, Externalizable, Serializable, EventListener

public class SchematicLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicLayer, ISchematicLayerTemplate, ISchematicLayerEditHelper, ILayer, ILayer2, IDataLayer, IDataLayer2, ILayerDrawingProperties, ITemporaryLayer, IGeoDataset, ILayerInfo, IPersist, IPersistStream, IIdentify, IIdentify2, ILayerGeneralProperties, IPublishLayer, ICompositeLayer, ICompositeLayer2, IMapLevel, ISymbolLevels, ILayerPosition, ILayerSymbologyExtents, IFeatureLayerSelectionEvents, Externalizable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicLayer, ISchematicLayerTemplate, ISchematicLayerEditHelper, ILayer, ILayer2, IDataLayer, IDataLayer2, ILayerDrawingProperties, ITemporaryLayer, IGeoDataset, ILayerInfo, IPersist, IPersistStream, IIdentify, IIdentify2, ILayerGeneralProperties, IPublishLayer, ICompositeLayer, ICompositeLayer2, IMapLevel, ISymbolLevels, ILayerPosition, ILayerSymbologyExtents, IFeatureLayerSelectionEvents, Externalizable

A Schematic layer object.

Product Availability

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

See Also:: Serialized Form

Constructor Summary
`SchematicLayer()` Constructs a SchematicLayer using ArcGIS Engine.
`SchematicLayer(Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `SchematicLayer theSchematicLayer = (SchematicLayer) obj;`

Method Summary
`boolean`	`connect(IName pOptRepairName)` Connects the layer to its data source.
`void`	`disconnect()` Disconnects the data from the layer.
`void`	`draw(int drawPhase, IDisplay display, ITrackCancel trackCancel)` Draws the layer to the specified display for the given draw phase.
`boolean`	`equals(Object o)` Compare this object with another
`void`	`expandRegionForSymbols(IDisplay pDisplay, IGeometry pRegion)` Enlarges the specified region if necessary to account for the symbology sizes.
`void`	`featureLayerSelectionChanged(IFeatureLayerSelectionEventsFeatureLayerSelectionChangedEvent theEvent)` Occurs when the selection changes.
`IEnvelope`	`getAreaOfInterest()` The default area of interest for the layer.
`void`	`getClassID(GUID[] pClassID)` getClassID
`static String`	`getClsid()` getClsid.
`int`	`getCount()` Number of layers in the collection.
`String`	`getDataDetails(String bsPadding)` Details of the layer's data.
`IName`	`getDataSourceName()` Name of the data object for the layer.
`IEnvelope`	`getExtent()` The extent of the GeoDataset.
`IPoint`	`getHighlightedVertex(boolean onlyVisible)` Position of the highlighted vertex.
`int`	`getLargeImage()` Large image that represents the layer.
`int`	`getLargeSelectedImage()` Large image that represents the layer when it is selected.
`double`	`getLastMaximumScale()` Last maximum scale setting used by layer.
`double`	`getLastMinimumScale()` Last minimum scale setting used by layer.
`ILayer`	`getLayer(int index)` Layer in the collection at the specified index.
`double`	`getLayerWeight()` Default layer position.
`int`	`getMapLevel()` Current map level for drawing multi-level symbols.
`double`	`getMaximumScale()` Maximum scale (representative fraction) at which the layer will display.
`double`	`getMinimumScale()` Minimum scale (representative fraction) at which the layer will display.
`String`	`getName()` Layer name.
`String`	`getPublishingDescription()` The layer description reported to the publisher.
`String`	`getRelativeBase()` Base path used when storing relative path names.
`ISchematicDiagram`	`getSchematicDiagram()` Schematic diagram of the schematic layer.
`IEnumSchematicFeature`	`getSchematicFeaturesAtPoint(IPoint point, double pointSearchDistance, boolean onlySelectable, boolean onlyVisible)` Schematic features selected in the schematic layer.
`IEnumSchematicFeature`	`getSchematicFeaturesAtPointByClass(ISchematicElementClass schematicElementClass, IPoint point, double pointSearchDistance, boolean onlySelectable, boolean onlyVisible)` Schematic features of the specified type around the specified point.
`IEnumSchematicFeature`	`getSchematicFeaturesAtPointByType(int elementType, IPoint point, double pointSearchDistance, boolean onlySelectable, boolean onlyVisible)` Schematic features around the specified point.
`IEnumSchematicFeature`	`getSchematicFeaturesInZone(IPolygon polygon, int spatialRelation, boolean onlySelectable, boolean onlyVisible)` Schematic features returned by a spatial query baed on a polygon.
`IEnumSchematicFeature`	`getSchematicFeaturesInZoneByClass(ISchematicElementClass schematicElementClass, IPolygon polygon, int spatialRelation, boolean onlySelectable, boolean onlyVisible)` Schematic features of the specified class returned by a spatial query baed on a polygon.
`IEnumSchematicFeature`	`getSchematicFeaturesInZoneByType(int elementType, IPolygon polygon, int spatialRelation, boolean onlySelectable, boolean onlyVisible)` Schematic features of the specified type returned by a spatial query baed on a polygon.
`ISchematicInMemoryDiagram`	`getSchematicInMemoryDiagram()` Schematic in memory diagram of the schematic layer.
`void`	`getSchematicInMemoryFeaturePortAtPoint(IPoint point, double pointSearchDistance, boolean onlySelectable, boolean onlyVisible, int[] portNumber, ISchematicInMemoryFeature[] inMemoryFeature)` In memory feature and his port number near to the given point.
`ISchematicInMemoryFeature`	`getSchematicInMemoryHighlightedFeature(boolean onlyVisible)` Schematic in memory highlighted feature.
`IEnumSchematicInMemoryFeature`	`getSchematicInMemorySelectedFeatures(boolean onlyVisible)` Enumeration of the selected in memory features.
`IEnumSchematicFeature`	`getSchematicSelectedFeatures(boolean onlyVisible)` Schematic in memory diagram of the schematic layer.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` getSizeMax
`int`	`getSmallImage()` Small image that represents the layer.
`int`	`getSmallSelectedImage()` Small image that represents the layer when it is selected.
`ISpatialReference`	`getSpatialReference()` The spatial reference of the GeoDataset.
`String`	`getSubLayerClassName(ILayer layer)` Element class name corresponding to a sub layer.
`int`	`getSupportedDrawPhases()` Supported draw phases.
`String`	`getTipText(double x, double y, double tolerance)` Map tip text at the specified location.
`int`	`hashCode()` the hashcode for this object
`IArray`	`identify(IGeometry pGeom)` Identifies objects at the specified location.
`IArray`	`identify(IGeometry pGeom, ITrackCancel pTrackCancel)` Identifies objects at the specified location.
`String`	`ILayerGeneralProperties_getLayerDescription()` Description for the layer.
`boolean`	`inWorkspace(IWorkspace workspace)` Returns TRUE if the layer is in the specified workspace.
`boolean`	`isCached()` Indicates if the layer needs its own display cache.
`boolean`	`isDataSourceSupported(IName name)` Indicates if the specified data object name is supported by the layer.
`boolean`	`isDataValid()` Indicates if the data for the layer is currently valid.
`void`	`isDirty()` isDirty
`boolean`	`isDrawingPropsDirty()` Indicates if the layer drawing properties are dirty.
`boolean`	`isEditingSchematicDiagram()` Indicates if the schematic diagram is being edited inside this layer.
`boolean`	`isExpanded()` Indicates if the layer is expanded in the TOC.
`boolean`	`isScaleRangeReadOnly()` Indicates if the minimum and maximum scale range values are read-only.
`boolean`	`isShowTips()` Indicates if the layer shows map tips.
`boolean`	`isSupportsPublishing()` Indicates if the layer supports the publishing process.
`boolean`	`isTemporary()` Indicates if the layer is a temporary layer.
`boolean`	`isUseSymbolLevels()` Indicates if symbol levels are used for drawing.
`boolean`	`isValid()` Indicates if the layer is currently valid.
`boolean`	`isVisible()` Indicates if the layer is currently visible.
`void`	`load(IStream pstm)` load
`void`	`prepareForPublishing()` Prepare the layer for the publishing process.
`void`	`readExternal(ObjectInput in)`
`void`	`save(IStream pstm, int fClearDirty)` save
`void`	`setAreaOfInterest(IEnvelope aoi)` The default area of interest for the layer.
`void`	`setCached(boolean cached)` Indicates if the layer needs its own display cache.
`void`	`setDataSourceName(IName name)` Name of the data object for the layer.
`void`	`setDrawingPropsDirty(boolean dirty)` Indicates if the layer drawing properties are dirty.
`void`	`setExpanded(boolean expanded)` Indicates if the layer is expanded in the TOC.
`void`	`setLayerDescription(String text)` Description for the layer.
`void`	`setLayerWeight(double layerWeight)` Default layer position.
`void`	`setMapLevel(int mapLevel)` Current map level for drawing multi-level symbols.
`void`	`setMaximumScale(double maxScale)` Maximum scale (representative fraction) at which the layer will display.
`void`	`setMinimumScale(double minScale)` Minimum scale (representative fraction) at which the layer will display.
`void`	`setName(String name)` Layer name.
`void`	`setRelativeBase(String basePath)` Base path used when storing relative path names.
`void`	`setScale(double rhs1)` The current scale of the display.
`void`	`setSchematicDiagramByRef(ISchematicDiagram diagram)` Schematic diagram of the schematic layer.
`void`	`setShowTips(boolean show)` Indicates if the layer shows map tips.
`void`	`setSpatialReferenceByRef(ISpatialReference rhs1)` Spatial reference for the layer.
`void`	`setTemporary(boolean temporary)` Indicates if the layer is a temporary layer.
`void`	`setUseSymbolLevels(boolean useSymbolLevels)` Indicates if symbol levels are used for drawing.
`void`	`setVisible(boolean visible)` Indicates if the layer is currently visible.
`void`	`startEditSchematicDiagram(boolean lockDiagram)` Start editing the schematic diagram.
`void`	`stopEditSchematicDiagram()` Stop editing the schematic diagram.
`void`	`updateExtent()` Recalculate the extent of the schematic diagram.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
`getJintegraDispatch, release`

Constructor Detail

SchematicLayer

public SchematicLayer()
               throws IOException,
                      UnknownHostException

Constructs a SchematicLayer using ArcGIS Engine.

Throws:: IOException - if there are interop problems; UnknownHostException - if there are interop problems

SchematicLayer

public SchematicLayer(Object obj)
               throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicLayer theSchematicLayer = (SchematicLayer) obj;

Construct a SchematicLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicLayer.

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

getSchematicDiagram

public ISchematicDiagram getSchematicDiagram()
                                      throws IOException,
                                             AutomationException

Schematic diagram of the schematic layer.

Product Availability

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

Specified by:: getSchematicDiagram in interface ISchematicLayer

Returns:: A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramByRef

public void setSchematicDiagramByRef(ISchematicDiagram diagram)
                              throws IOException,
                                     AutomationException

Schematic diagram of the schematic layer.

Product Availability

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

Specified by:: setSchematicDiagramByRef in interface ISchematicLayer

Parameters:: diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryDiagram

public ISchematicInMemoryDiagram getSchematicInMemoryDiagram()
                                                      throws IOException,
                                                             AutomationException

Schematic in memory diagram of the schematic layer.

Product Availability

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

Specified by:: getSchematicInMemoryDiagram in interface ISchematicLayer

Returns:: A reference to a com.esri.arcgis.schematic.ISchematicInMemoryDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicSelectedFeatures

public IEnumSchematicFeature getSchematicSelectedFeatures(boolean onlyVisible)
                                                   throws IOException,
                                                          AutomationException

Schematic in memory diagram of the schematic layer.

Product Availability

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

Specified by:: getSchematicSelectedFeatures in interface ISchematicLayer

Parameters:: onlyVisible - The onlyVisible (in)
Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesAtPoint

public IEnumSchematicFeature getSchematicFeaturesAtPoint(IPoint point,
                                                         double pointSearchDistance,
                                                         boolean onlySelectable,
                                                         boolean onlyVisible)
                                                  throws IOException,
                                                         AutomationException

Schematic features selected in the schematic layer.

Product Availability

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

Specified by:: getSchematicFeaturesAtPoint in interface ISchematicLayer

Parameters:: point - A reference to a com.esri.arcgis.geometry.IPoint (in); pointSearchDistance - The pointSearchDistance (in); onlySelectable - The onlySelectable (in); onlyVisible - The onlyVisible (in)
Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesAtPointByType

public IEnumSchematicFeature getSchematicFeaturesAtPointByType(int elementType,
                                                               IPoint point,
                                                               double pointSearchDistance,
                                                               boolean onlySelectable,
                                                               boolean onlyVisible)
                                                        throws IOException,
                                                               AutomationException

Schematic features around the specified point.

Product Availability

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

Specified by:: getSchematicFeaturesAtPointByType in interface ISchematicLayer

Parameters:: elementType - A com.esri.arcgis.schematic.esriSchematicElementType constant (in); point - A reference to a com.esri.arcgis.geometry.IPoint (in); pointSearchDistance - The pointSearchDistance (in); onlySelectable - The onlySelectable (in); onlyVisible - The onlyVisible (in)
Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesAtPointByClass

public IEnumSchematicFeature getSchematicFeaturesAtPointByClass(ISchematicElementClass schematicElementClass,
                                                                IPoint point,
                                                                double pointSearchDistance,
                                                                boolean onlySelectable,
                                                                boolean onlyVisible)
                                                         throws IOException,
                                                                AutomationException

Schematic features of the specified type around the specified point.

Product Availability

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

Specified by:: getSchematicFeaturesAtPointByClass in interface ISchematicLayer

Parameters:: schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in); point - A reference to a com.esri.arcgis.geometry.IPoint (in); pointSearchDistance - The pointSearchDistance (in); onlySelectable - The onlySelectable (in); onlyVisible - The onlyVisible (in)
Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesInZone

public IEnumSchematicFeature getSchematicFeaturesInZone(IPolygon polygon,
                                                        int spatialRelation,
                                                        boolean onlySelectable,
                                                        boolean onlyVisible)
                                                 throws IOException,
                                                        AutomationException

Schematic features returned by a spatial query baed on a polygon.

Product Availability

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

Specified by:: getSchematicFeaturesInZone in interface ISchematicLayer

Parameters:: polygon - A reference to a com.esri.arcgis.geometry.IPolygon (in); spatialRelation - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in); onlySelectable - The onlySelectable (in); onlyVisible - The onlyVisible (in)
Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesInZoneByType

public IEnumSchematicFeature getSchematicFeaturesInZoneByType(int elementType,
                                                              IPolygon polygon,
                                                              int spatialRelation,
                                                              boolean onlySelectable,
                                                              boolean onlyVisible)
                                                       throws IOException,
                                                              AutomationException

Schematic features of the specified type returned by a spatial query baed on a polygon.

Product Availability

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

Specified by:: getSchematicFeaturesInZoneByType in interface ISchematicLayer

Parameters:: elementType - A com.esri.arcgis.schematic.esriSchematicElementType constant (in); polygon - A reference to a com.esri.arcgis.geometry.IPolygon (in); spatialRelation - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in); onlySelectable - The onlySelectable (in); onlyVisible - The onlyVisible (in)
Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesInZoneByClass

public IEnumSchematicFeature getSchematicFeaturesInZoneByClass(ISchematicElementClass schematicElementClass,
                                                               IPolygon polygon,
                                                               int spatialRelation,
                                                               boolean onlySelectable,
                                                               boolean onlyVisible)
                                                        throws IOException,
                                                               AutomationException

Schematic features of the specified class returned by a spatial query baed on a polygon.

Product Availability

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

Specified by:: getSchematicFeaturesInZoneByClass in interface ISchematicLayer

Parameters:: schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in); polygon - A reference to a com.esri.arcgis.geometry.IPolygon (in); spatialRelation - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in); onlySelectable - The onlySelectable (in); onlyVisible - The onlyVisible (in)
Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

startEditSchematicDiagram

public void startEditSchematicDiagram(boolean lockDiagram)
                               throws IOException,
                                      AutomationException

Start editing the schematic diagram.

Product Availability

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

Specified by:: startEditSchematicDiagram in interface ISchematicLayer

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

stopEditSchematicDiagram

public void stopEditSchematicDiagram()
                              throws IOException,
                                     AutomationException

Stop editing the schematic diagram.

Product Availability

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

Specified by:: stopEditSchematicDiagram in interface ISchematicLayer

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

isEditingSchematicDiagram

public boolean isEditingSchematicDiagram()
                                  throws IOException,
                                         AutomationException

Indicates if the schematic diagram is being edited inside this layer.

Product Availability

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

Specified by:: isEditingSchematicDiagram in interface ISchematicLayer

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

updateExtent

public void updateExtent()
                  throws IOException,
                         AutomationException

Recalculate the extent of the schematic diagram.

Product Availability

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

Specified by:: updateExtent in interface ISchematicLayer

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

getSubLayerClassName

public String getSubLayerClassName(ILayer layer)
                            throws IOException,
                                   AutomationException

Element class name corresponding to a sub layer.

Product Availability

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

Specified by:: getSubLayerClassName in interface ISchematicLayerTemplate

Parameters:: layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:: The className
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHighlightedVertex

public IPoint getHighlightedVertex(boolean onlyVisible)
                            throws IOException,
                                   AutomationException

Position of the highlighted vertex.

Product Availability

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

Specified by:: getHighlightedVertex in interface ISchematicLayerEditHelper

Parameters:: onlyVisible - The onlyVisible (in)
Returns:: A reference to a com.esri.arcgis.geometry.IPoint
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryHighlightedFeature

public ISchematicInMemoryFeature getSchematicInMemoryHighlightedFeature(boolean onlyVisible)
                                                                 throws IOException,
                                                                        AutomationException

Schematic in memory highlighted feature.

Product Availability

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

Specified by:: getSchematicInMemoryHighlightedFeature in interface ISchematicLayerEditHelper

Parameters:: onlyVisible - The onlyVisible (in)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicInMemorySelectedFeatures

public IEnumSchematicInMemoryFeature getSchematicInMemorySelectedFeatures(boolean onlyVisible)
                                                                   throws IOException,
                                                                          AutomationException

Enumeration of the selected in memory features.

Product Availability

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

Specified by:: getSchematicInMemorySelectedFeatures in interface ISchematicLayerEditHelper

Parameters:: onlyVisible - The onlyVisible (in)
Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicInMemoryFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryFeaturePortAtPoint

public void getSchematicInMemoryFeaturePortAtPoint(IPoint point,
                                                   double pointSearchDistance,
                                                   boolean onlySelectable,
                                                   boolean onlyVisible,
                                                   int[] portNumber,
                                                   ISchematicInMemoryFeature[] inMemoryFeature)
                                            throws IOException,
                                                   AutomationException

In memory feature and his port number near to the given point.

Product Availability

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

Specified by:: getSchematicInMemoryFeaturePortAtPoint in interface ISchematicLayerEditHelper

Parameters:: point - A reference to a com.esri.arcgis.geometry.IPoint (in); pointSearchDistance - The pointSearchDistance (in); onlySelectable - The onlySelectable (in); onlyVisible - The onlyVisible (in); portNumber - The portNumber (in/out: use single element array); inMemoryFeature - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in/out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Layer name.

Description

Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getName in interface ILayer
Specified by:: getName in interface ILayer2

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

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Layer name.

Description

Use the Name property to associate a string with the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setName in interface ILayer
Specified by:: setName in interface ILayer2

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

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the layer is currently valid.

Remarks

The valid property indicates if the layer is currently valid. Layers that reference feature classes are valid when they hold a reference to a valid feature class. The property does not however validate the integrity of the feature classes reference to the database. Therefore, in rare situations if a datasource is removed after a layer is initialized, the layer will report itself as valid but query attempts to the data source will error due to the lack of underlying data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isValid in interface ILayer
Specified by:: isValid in interface ILayer2

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

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAreaOfInterest in interface ILayer
Specified by:: getAreaOfInterest in interface ILayer2

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws IOException,
                              AutomationException

Minimum scale (representative fraction) at which the layer will display.

Remarks

Specifies the minimum scale at which the layer will be displayed. This means that if you zoom out beyond this scale, the layer will not display. For example, specify 1000 to have the layer not display when zoomed out beyond 1:1000.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMinimumScale in interface ILayer
Specified by:: getMinimumScale in interface ILayer2

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

setMinimumScale

public void setMinimumScale(double minScale)
                     throws IOException,
                            AutomationException

Minimum scale (representative fraction) at which the layer will display.

Description

MinimumScale property specifies the minimum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMinimumScale in interface ILayer
Specified by:: setMinimumScale in interface ILayer2

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

getMaximumScale

public double getMaximumScale()
                       throws IOException,
                              AutomationException

Maximum scale (representative fraction) at which the layer will display.

Remarks

Specifies the maximum scale at which the layer will be displayed. This means that if you zoom in beyond this scale, the layer will not display. For example, specify 500 to have the layer not display when zoomed in beyond 1:500.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMaximumScale in interface ILayer
Specified by:: getMaximumScale in interface ILayer2

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

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws IOException,
                            AutomationException

Maximum scale (representative fraction) at which the layer will display.

Description

MaximumScale property specifies the maximum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMaximumScale in interface ILayer
Specified by:: setMaximumScale in interface ILayer2

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

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isVisible in interface ILayer
Specified by:: isVisible in interface ILayer2

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

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the layer is currently visible.

Description

Use Visible property to set the visibility of the layer. When assigned False, the layer is invisible in the current view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setVisible in interface ILayer
Specified by:: setVisible in interface ILayer2

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

isShowTips

public boolean isShowTips()
                   throws IOException,
                          AutomationException

Indicates if the layer shows map tips.

Remarks

Indicates whether or not map tips are shown for the layer. If set to True, then map tips will be shown for the layer. You can determine the text that will be shown via TipText. For a FeatureLayer, this text comes from the data for IFeatureLayer::DisplayField.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowTips in interface ILayer
Specified by:: isShowTips in interface ILayer2

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

setShowTips

public void setShowTips(boolean show)
                 throws IOException,
                        AutomationException

Indicates if the layer shows map tips.

Description

ShowTips is set to True when the layer shows map tips specified in the TipText property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowTips in interface ILayer
Specified by:: setShowTips in interface ILayer2

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

getTipText

public String getTipText(double x,
                         double y,
                         double tolerance)
                  throws IOException,
                         AutomationException

Map tip text at the specified location.

Product Availability

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

Specified by:: getTipText in interface ILayer
Specified by:: getTipText in interface ILayer2

Parameters:: x - The x (in); y - The y (in); tolerance - The tolerance (in)
Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws IOException,
                        AutomationException

Indicates if the layer needs its own display cache.

Remarks

This property indicates whether or not the layer requires its own display cache. If this property is True, then the Map will use a separate display cache for the layer so that it can be refreshed indpendently of other layers.

The Map is responsible for cache management. See IScreenDisplay::AddCache for more information on caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCached in interface ILayer
Specified by:: isCached in interface ILayer2

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

setCached

public void setCached(boolean cached)
               throws IOException,
                      AutomationException

Indicates if the layer needs its own display cache.

Description

Use Cached property to indicate if the layer needs its own cache for display.

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCached in interface ILayer
Specified by:: setCached in interface ILayer2

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

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws IOException,
                                  AutomationException

Supported draw phases.

Remarks

Indicates the draw phases supported by the layer (esriDPGeography, esriDPAnnotation, esriDPSelection, or any combination of the three). The supported draw phases are defined by esriDrawPhase. When multiple draw phases are supported, the sum of the constants is used. For example, if SupportedDrawPhases = 3 then the layer supports drawing in the geography and annotation phases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSupportedDrawPhases in interface ILayer
Specified by:: getSupportedDrawPhases in interface ILayer2

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

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws IOException,
                                     AutomationException

Spatial reference for the layer.

Remarks

This property is only used for map display, setting this property does not change the spatial reference of the layer's underlying data. The ArcGIS framework uses this property to pass the spatial reference from the map to the layer in order to support on-the-fly projection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSpatialReferenceByRef in interface ILayer
Specified by:: setSpatialReferenceByRef in interface ILayer2

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

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws the layer to the specified display for the given draw phase.

Remarks

This method draws the layer to the Display for the specified DrawPhase. Use the TrackCancel object to allow the drawing of the layer to be interrupted by the user.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: draw in interface ILayer
Specified by:: draw in interface ILayer2

Parameters:: drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in); display - A reference to a com.esri.arcgis.display.IDisplay (in); trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

public boolean isScaleRangeReadOnly()
                             throws IOException,
                                    AutomationException

Indicates if the minimum and maximum scale range values are read-only.

Remarks

Some layer types do not support a writeable MinimumScale or MaximumScale. Use this property to determine whether or not a layer supports this.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isScaleRangeReadOnly in interface ILayer2

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

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws IOException,
                              AutomationException

The default area of interest for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAreaOfInterest in interface ILayer2

Parameters:: aoi - 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.

getDataSourceName

public IName getDataSourceName()
                        throws IOException,
                               AutomationException

Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDataSourceName in interface IDataLayer
Specified by:: getDataSourceName in interface IDataLayer2

Returns:: A reference to a com.esri.arcgis.system.IName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDataSourceName

public void setDataSourceName(IName name)
                       throws IOException,
                              AutomationException

Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDataSourceName in interface IDataLayer
Specified by:: setDataSourceName in interface IDataLayer2

Parameters:: name - A reference to a com.esri.arcgis.system.IName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws IOException,
                                     AutomationException

Indicates if the specified data object name is supported by the layer.

Product Availability

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

Specified by:: isDataSourceSupported in interface IDataLayer
Specified by:: isDataSourceSupported in interface IDataLayer2

Parameters:: name - A reference to a com.esri.arcgis.system.IName (in)
Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws IOException,
                       AutomationException

Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: connect in interface IDataLayer
Specified by:: connect in interface IDataLayer2

Parameters:: pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)
Returns:: The succeeded
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public String getRelativeBase()
                       throws IOException,
                              AutomationException

Base path used when storing relative path names.

Remarks

The RelativeBase property is used internally when persisting and loading documents with a relative path. When a document has been fully loaded the path is realized to a complete path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRelativeBase in interface IDataLayer
Specified by:: getRelativeBase in interface IDataLayer2

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

setRelativeBase

public void setRelativeBase(String basePath)
                     throws IOException,
                            AutomationException

Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setRelativeBase in interface IDataLayer
Specified by:: setRelativeBase in interface IDataLayer2

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

disconnect

public void disconnect()
                throws IOException,
                       AutomationException

Disconnects the data from the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: disconnect in interface IDataLayer2

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

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws IOException,
                           AutomationException

Returns TRUE if the layer is in the specified workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: inWorkspace in interface IDataLayer2

Parameters:: workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: The inWorkspace
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDrawingPropsDirty

public boolean isDrawingPropsDirty()
                            throws IOException,
                                   AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDrawingPropsDirty in interface ILayerDrawingProperties

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

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws IOException,
                                 AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDrawingPropsDirty in interface ILayerDrawingProperties

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

setTemporary

public void setTemporary(boolean temporary)
                  throws IOException,
                         AutomationException

Indicates if the layer is a temporary layer.

Product Availability

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

Specified by:: setTemporary in interface ITemporaryLayer

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

isTemporary

public boolean isTemporary()
                    throws IOException,
                           AutomationException

Indicates if the layer is a temporary layer.

Product Availability

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

Specified by:: isTemporary in interface ITemporaryLayer

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpatialReference in interface IGeoDataset

Returns:: A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtent in interface IGeoDataset

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException

Small image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSmallImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws IOException,
                                 AutomationException

Small image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSmallSelectedImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException

Large image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLargeImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws IOException,
                                 AutomationException

Large image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLargeSelectedImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDirty in interface IPersistStream

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

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: load in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: identify in interface IIdentify

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

identify

public IArray identify(IGeometry pGeom,
                       ITrackCancel pTrackCancel)
                throws IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: identify in interface IIdentify2

Parameters:: pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in); pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(double rhs1)
              throws IOException,
                     AutomationException

The current scale of the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setScale in interface IIdentify2

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

getLastMinimumScale

public double getLastMinimumScale()
                           throws IOException,
                                  AutomationException

Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLastMinimumScale in interface ILayerGeneralProperties

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

getLastMaximumScale

public double getLastMaximumScale()
                           throws IOException,
                                  AutomationException

Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLastMaximumScale in interface ILayerGeneralProperties

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

ILayerGeneralProperties_getLayerDescription

public String ILayerGeneralProperties_getLayerDescription()
                                                   throws IOException,
                                                          AutomationException

Description for the layer.

Product Availability

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

Specified by:: ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties

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

setLayerDescription

public void setLayerDescription(String text)
                         throws IOException,
                                AutomationException

Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLayerDescription in interface ILayerGeneralProperties

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

isSupportsPublishing

public boolean isSupportsPublishing()
                             throws IOException,
                                    AutomationException

Indicates if the layer supports the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsPublishing in interface IPublishLayer

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

getPublishingDescription

public String getPublishingDescription()
                                throws IOException,
                                       AutomationException

The layer description reported to the publisher.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPublishingDescription in interface IPublishLayer

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

isDataValid

public boolean isDataValid()
                    throws IOException,
                           AutomationException

Indicates if the data for the layer is currently valid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDataValid in interface IPublishLayer

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

getDataDetails

public String getDataDetails(String bsPadding)
                      throws IOException,
                             AutomationException

Details of the layer's data.

Product Availability

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

Specified by:: getDataDetails in interface IPublishLayer

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

prepareForPublishing

public void prepareForPublishing()
                          throws IOException,
                                 AutomationException

Prepare the layer for the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: prepareForPublishing in interface IPublishLayer

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

getCount

public int getCount()
             throws IOException,
                    AutomationException

Number of layers in the collection.

Description

Returns the count, or number of layers. Use the methods in the IGroupLayer interface to manage the contents of GroupLayers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCount in interface ICompositeLayer
Specified by:: getCount in interface ICompositeLayer2

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

getLayer

public ILayer getLayer(int index)
                throws IOException,
                       AutomationException

Layer in the collection at the specified index.

Product Availability

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

Specified by:: getLayer in interface ICompositeLayer
Specified by:: getLayer in interface ICompositeLayer2

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.ILayer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isExpanded

public boolean isExpanded()
                   throws IOException,
                          AutomationException

Indicates if the layer is expanded in the TOC.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isExpanded in interface ICompositeLayer2

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

setExpanded

public void setExpanded(boolean expanded)
                 throws IOException,
                        AutomationException

Indicates if the layer is expanded in the TOC.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setExpanded in interface ICompositeLayer2

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

getMapLevel

public int getMapLevel()
                throws IOException,
                       AutomationException

Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMapLevel in interface IMapLevel

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

setMapLevel

public void setMapLevel(int mapLevel)
                 throws IOException,
                        AutomationException

Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMapLevel in interface IMapLevel

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

isUseSymbolLevels

public boolean isUseSymbolLevels()
                          throws IOException,
                                 AutomationException

Indicates if symbol levels are used for drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUseSymbolLevels in interface ISymbolLevels

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

setUseSymbolLevels

public void setUseSymbolLevels(boolean useSymbolLevels)
                        throws IOException,
                               AutomationException

Indicates if symbol levels are used for drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setUseSymbolLevels in interface ISymbolLevels

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

getLayerWeight

public double getLayerWeight()
                      throws IOException,
                             AutomationException

Default layer position.

Description

The LayerWeight property defines the weight of the layer in the auto arrange order. During auto arrange, the higher weight layers are added to the map first, which means they draw lower in the draw order.

Default weights for layers are these values:
Annotation layers = 97
Points layers = 98
Polyline layers = 99
Polygon Layers = 100

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLayerWeight in interface ILayerPosition

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

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws IOException,
                           AutomationException

Default layer position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLayerWeight in interface ILayerPosition

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

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay pDisplay,
                                   IGeometry pRegion)
                            throws IOException,
                                   AutomationException

Enlarges the specified region if necessary to account for the symbology sizes.

Product Availability

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

Specified by:: expandRegionForSymbols in interface ILayerSymbologyExtents

Parameters:: pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in); pRegion - 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.

featureLayerSelectionChanged

public void featureLayerSelectionChanged(IFeatureLayerSelectionEventsFeatureLayerSelectionChangedEvent theEvent)
                                  throws IOException,
                                         AutomationException

Occurs when the selection changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: featureLayerSelectionChanged in interface IFeatureLayerSelectionEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable

Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable

Throws:: IOException; ClassNotFoundException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.schematic Class SchematicLayer

Product Availability

SchematicLayer

SchematicLayer

getClsid

equals

hashCode

getSchematicDiagram

Product Availability

setSchematicDiagramByRef

Product Availability

getSchematicInMemoryDiagram

Product Availability

getSchematicSelectedFeatures

Product Availability

getSchematicFeaturesAtPoint

Product Availability

getSchematicFeaturesAtPointByType

Product Availability

getSchematicFeaturesAtPointByClass

Product Availability

getSchematicFeaturesInZone

Product Availability

getSchematicFeaturesInZoneByType

Product Availability

getSchematicFeaturesInZoneByClass

Product Availability

startEditSchematicDiagram

Product Availability

stopEditSchematicDiagram

Product Availability

isEditingSchematicDiagram

Product Availability

updateExtent

Product Availability

getSubLayerClassName

Product Availability

getHighlightedVertex

Product Availability

getSchematicInMemoryHighlightedFeature

Product Availability

getSchematicInMemorySelectedFeatures

Product Availability

getSchematicInMemoryFeaturePortAtPoint

Product Availability

getName

Description

Remarks

Product Availability

Supported Platforms

setName

Description

Product Availability

Supported Platforms

isValid

Remarks

Product Availability

Supported Platforms

getAreaOfInterest

Remarks

Product Availability

Supported Platforms

getMinimumScale

Remarks

Product Availability

Supported Platforms

setMinimumScale

Description

Product Availability

Supported Platforms

getMaximumScale

Remarks

Product Availability

Supported Platforms

setMaximumScale

Description

Product Availability

Supported Platforms

isVisible

Product Availability

com.esri.arcgis.schematic
Class SchematicLayer