com.esri.arcgis.catalog
Interface IGxFileFilter

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GxFileFilter, IGxFileFilterProxy

public interface IGxFileFilter
extends java.io.Serializable

COM Interface 'IGxFileFilter'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description: 'Provides access to members that manage a file filter for various file types.' 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	IIDbdbbb3f7_d0b2_11d1_aed9_080009ec734b
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addFileType(java.lang.String extension, java.lang.String description, java.lang.String filePathImage) Add the file type to the collection.
void	deleteFileType(int index) Remove the file type.
boolean	filter(java.lang.String filePath) Checks to see if the indicated file passes the filter.
int	findFileType(java.lang.String extension) The index of the file type in the filter or -1.
void	getFileType(int index, java.lang.String[] extension, java.lang.String[] description, java.lang.String[] imageFile, int[] smallBitmap, int[] largeBitmap) Returns information on the file type at the specified index in the file filter.
int	getFileTypeCount() The number of file types for the filter.

Field Detail

IIDbdbbb3f7_d0b2_11d1_aed9_080009ec734b

static final int IIDbdbbb3f7_d0b2_11d1_aed9_080009ec734b

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

filter

boolean filter(java.lang.String filePath)
               throws java.io.IOException,
                      AutomationException

Checks to see if the indicated file passes the filter.

Parameters:

filePath - The filePath (in)

Returns:

The passesFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findFileType

int findFileType(java.lang.String extension)
                 throws java.io.IOException,
                        AutomationException

The index of the file type in the filter or -1.

Parameters:

extension - The extension (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileTypeCount

int getFileTypeCount()
                     throws java.io.IOException,
                            AutomationException

The number of file types for the filter.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileType

void getFileType(int index,
                 java.lang.String[] extension,
                 java.lang.String[] description,
                 java.lang.String[] imageFile,
                 int[] smallBitmap,
                 int[] largeBitmap)
                 throws java.io.IOException,
                        AutomationException

Returns information on the file type at the specified index in the file filter.

Parameters:

index - The index (in)

extension - The extension (out: use single element array)

description - The description (out: use single element array)

imageFile - The imageFile (out: use single element array)

smallBitmap - The smallBitmap (A COM typedef) (out: use single element array)

largeBitmap - The largeBitmap (A COM typedef) (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addFileType

void addFileType(java.lang.String extension,
                 java.lang.String description,
                 java.lang.String filePathImage)
                 throws java.io.IOException,
                        AutomationException

Add the file type to the collection.

Parameters:

extension - The extension (in)

description - The description (in)

filePathImage - The filePathImage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteFileType

void deleteFileType(int index)
                    throws java.io.IOException,
                           AutomationException

Remove the file type.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.