com.esri.arcgis.arcscene
Interface ISxDocument

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ISxDocumentProxy, SxDocument

public interface ISxDocument
extends java.io.Serializable

COM Interface 'ISxDocument'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriArcScene.olb'

Description: 'Provides access to members that control the ArcScene Document object.' 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 IIDc80aa9de_a836_11d3_abb8_0008c73fca1c
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addLayer(ILayer layer)
          Adds a layer to the current focus map.
 ISxContentsView getContentsView(int index)
          The contents view at the specified index.
 int getContentsViewCount()
          The number of contents views in the document.
 java.lang.Object getContextItem()
          The item that is selected or was last right-clicked.
 ISxContentsView getCurrentContentsView()
          The current contents view of the document.
 IColor getDefaultColor(int type)
          The default color for the given type.
 IScene getScene()
          The scene.
 int getSearchTolerancePixels()
          The global search tolerance in pixels for selection.
 java.lang.Object getSelectedItem()
          The selected item in the layer control.
 ILayer getSelectedLayer()
          The selected layer in the layer control.
 boolean isRelativePaths()
          Indicates if path names are stored relative to the document.
 boolean isSavePreview()
          Indicates if a preview image is saved in the document.
 void removeAllLayers()
          Removes all layers.
 void setContextItem(java.lang.Object item)
          The item that is selected or was last right-clicked.
 void setCurrentContentsViewByRef(ISxContentsView view)
          The current contents view of the document.
 void setDefaultColor(int type, IColor color)
          The default color for the given type.
 void setDelayUpdateContents(boolean rhs1)
          Indicates whether to ignore document update notifications.
 void setRelativePaths(boolean relPaths)
          Indicates if path names are stored relative to the document.
 void setSavePreview(boolean savePreview)
          Indicates if a preview image is saved in the document.
 void setScene(IScene pScene)
          The scene.
 void setSearchTolerancePixels(int tol)
          The global search tolerance in pixels for selection.
 void updateContents()
          Notifies the document that the contents have been updated.
 

Field Detail

IIDc80aa9de_a836_11d3_abb8_0008c73fca1c

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

getSelectedLayer

ILayer getSelectedLayer()
                        throws java.io.IOException,
                               AutomationException
The selected layer in the layer control.

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

getSelectedItem

java.lang.Object getSelectedItem()
                                 throws java.io.IOException,
                                        AutomationException
The selected item in the layer control.

Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContextItem

java.lang.Object getContextItem()
                                throws java.io.IOException,
                                       AutomationException
The item that is selected or was last right-clicked.

Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setContextItem

void setContextItem(java.lang.Object item)
                    throws java.io.IOException,
                           AutomationException
The item that is selected or was last right-clicked.

Parameters:
item - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(ILayer layer)
              throws java.io.IOException,
                     AutomationException
Adds a layer to the current focus map.

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

removeAllLayers

void removeAllLayers()
                     throws java.io.IOException,
                            AutomationException
Removes all layers.

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

updateContents

void updateContents()
                    throws java.io.IOException,
                           AutomationException
Notifies the document that the contents have been updated.

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

setDelayUpdateContents

void setDelayUpdateContents(boolean rhs1)
                            throws java.io.IOException,
                                   AutomationException
Indicates whether to ignore document update notifications.

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

getSearchTolerancePixels

int getSearchTolerancePixels()
                             throws java.io.IOException,
                                    AutomationException
The global search tolerance in pixels for selection.

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

setSearchTolerancePixels

void setSearchTolerancePixels(int tol)
                              throws java.io.IOException,
                                     AutomationException
The global search tolerance in pixels for selection.

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

getDefaultColor

IColor getDefaultColor(int type)
                       throws java.io.IOException,
                              AutomationException
The default color for the given type.

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

setDefaultColor

void setDefaultColor(int type,
                     IColor color)
                     throws java.io.IOException,
                            AutomationException
The default color for the given type.

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

getScene

IScene getScene()
                throws java.io.IOException,
                       AutomationException
The scene.

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

setScene

void setScene(IScene pScene)
              throws java.io.IOException,
                     AutomationException
The scene.

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

isRelativePaths

boolean isRelativePaths()
                        throws java.io.IOException,
                               AutomationException
Indicates if path names are stored relative to the document.

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

setRelativePaths

void setRelativePaths(boolean relPaths)
                      throws java.io.IOException,
                             AutomationException
Indicates if path names are stored relative to the document.

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

isSavePreview

boolean isSavePreview()
                      throws java.io.IOException,
                             AutomationException
Indicates if a preview image is saved in the document.

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

setSavePreview

void setSavePreview(boolean savePreview)
                    throws java.io.IOException,
                           AutomationException
Indicates if a preview image is saved in the document.

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

getCurrentContentsView

ISxContentsView getCurrentContentsView()
                                       throws java.io.IOException,
                                              AutomationException
The current contents view of the document.

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

setCurrentContentsViewByRef

void setCurrentContentsViewByRef(ISxContentsView view)
                                 throws java.io.IOException,
                                        AutomationException
The current contents view of the document.

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

getContentsViewCount

int getContentsViewCount()
                         throws java.io.IOException,
                                AutomationException
The number of contents views in the document.

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

getContentsView

ISxContentsView getContentsView(int index)
                                throws java.io.IOException,
                                       AutomationException
The contents view at the specified index.

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