com.esri.arcgis.carto
Interface ILayerFile

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ILayerFileProxy, LayerFile

public interface ILayerFile
extends java.io.Serializable

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

Description: 'Provides access to members that control the reading and writing of layer document files.' 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	IID58478051_486a_4093_a620_a558af78baf5
static int	xxDummy Deprecated. Internal use only

Method Summary

void	close() Close the layer file.
void	esri_new(java.lang.String sFile) Creates and opens a new layer File in preparation for the contents to be retrieve or updated.
java.lang.String	getFilename() The name of the layer file that the LayerFile coclass is linked to.
ILayer	getLayer() The Layer object.
IPicture	getThumbnail() The thumbnail stored in the layer file.
boolean	isLayerFile(java.lang.String sFile) Indicates if the file is a valid layer file.
boolean	isPresent(java.lang.String sFile) Indicates if the layer file is present.
boolean	isReadOnly(java.lang.String sFile) Indicates if the layer file is read only.
void	open(java.lang.String sFile) Open the layer file in preparation for the contents to be retrieved or updated.
void	replaceContents(ILayer pLayer) Replace the contents of the layer file.
void	save() Save the contents of the layer file to the bound file.
void	saveAs(java.lang.String sFile) Save the contents of the layer file to the specified file name.

Field Detail

IID58478051_486a_4093_a620_a558af78baf5

static final int IID58478051_486a_4093_a620_a558af78baf5

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

getFilename

java.lang.String getFilename()
                             throws java.io.IOException,
                                    AutomationException

The name of the layer file that the LayerFile coclass is linked to.

Returns:

The sFile

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLayerFile

boolean isLayerFile(java.lang.String sFile)
                    throws java.io.IOException,
                           AutomationException

Indicates if the file is a valid layer file.

Parameters:

sFile - The sFile (in)

Returns:

The isLayerFile

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPresent

boolean isPresent(java.lang.String sFile)
                  throws java.io.IOException,
                         AutomationException

Indicates if the layer file is present.

Parameters:

sFile - The sFile (in)

Returns:

The isPresent

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReadOnly

boolean isReadOnly(java.lang.String sFile)
                   throws java.io.IOException,
                          AutomationException

Indicates if the layer file is read only.

Parameters:

sFile - The sFile (in)

Returns:

The isReadOnly

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer()
                throws java.io.IOException,
                       AutomationException

The Layer object. If no layer object is stored in the layer file this returns NULL.

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.

getThumbnail

IPicture getThumbnail()
                      throws java.io.IOException,
                             AutomationException

The thumbnail stored in the layer file. If this is empty E_FAIL is returned.

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.IPicture

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_new

void esri_new(java.lang.String sFile)
              throws java.io.IOException,
                     AutomationException

Creates and opens a new layer File in preparation for the contents to be retrieve or updated.

Parameters:

sFile - The sFile (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

void open(java.lang.String sFile)
          throws java.io.IOException,
                 AutomationException

Open the layer file in preparation for the contents to be retrieved or updated.

Parameters:

sFile - The sFile (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

void close()
           throws java.io.IOException,
                  AutomationException

Close the layer file.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceContents

void replaceContents(ILayer pLayer)
                     throws java.io.IOException,
                            AutomationException

Replace the contents of the layer file.

Parameters:

pLayer - 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.

save

void save()
          throws java.io.IOException,
                 AutomationException

Save the contents of the layer file to the bound file.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveAs

void saveAs(java.lang.String sFile)
            throws java.io.IOException,
                   AutomationException

Save the contents of the layer file to the specified file name.

Parameters:

sFile - The sFile (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.