com.esri.arcgis.display
Interface IStyleGallery

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IStyleGalleryProxy, ServerStyleGallery, StyleGallery

public interface IStyleGallery
extends java.io.Serializable

COM Interface 'IStyleGallery'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description: 'Provides access to members modify the Style Gallery.' 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	IIDac0e9826_91cb_11d1_8813_080009ec732a
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addItem(IStyleGalleryItem item) Adds an item to the target style file.
void	clear() Removes all styles from the Style Gallery.
IStyleGalleryClass	esri_getClass(int index) The class at the given index.
IEnumBSTR	getCategories(java.lang.String className) The categories within the given class.
int	getClassCount() Number of classes in the Style Gallery.
IEnumStyleGalleryItem	getItems(java.lang.String className, java.lang.String styleSet, java.lang.String category) The style items from the specified style file, in the specified class and category.
void	importStyle(java.lang.String fileName) Imports a style from a file other than a .style file.
void	loadStyle(java.lang.String fileName, java.lang.String className) Loads a style from a file.
void	removeItem(IStyleGalleryItem item) Removes an item from the target style file.
void	saveStyle(java.lang.String fileName, java.lang.String styleSet, java.lang.String className) Saves the specified style to a file.
void	updateItem(IStyleGalleryItem item) Updates an existing item in target style file.

Field Detail

IIDac0e9826_91cb_11d1_8813_080009ec732a

static final int IIDac0e9826_91cb_11d1_8813_080009ec732a

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

getClassCount

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

Number of classes in the Style Gallery.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_getClass

IStyleGalleryClass esri_getClass(int index)
                                 throws java.io.IOException,
                                        AutomationException

The class at the given index.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.display.IStyleGalleryClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategories

IEnumBSTR getCategories(java.lang.String className)
                        throws java.io.IOException,
                               AutomationException

The categories within the given class.

Parameters:

className - The className (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItems

IEnumStyleGalleryItem getItems(java.lang.String className,
                               java.lang.String styleSet,
                               java.lang.String category)
                               throws java.io.IOException,
                                      AutomationException

The style items from the specified style file, in the specified class and category. The style set and category may be blank to return all items.

Parameters:

className - The className (in)

styleSet - The styleSet (in)

category - The category (in)

Returns:

A reference to a com.esri.arcgis.display.IEnumStyleGalleryItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addItem

void addItem(IStyleGalleryItem item)
             throws java.io.IOException,
                    AutomationException

Adds an item to the target style file.

Parameters:

item - A reference to a com.esri.arcgis.display.IStyleGalleryItem (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateItem

void updateItem(IStyleGalleryItem item)
                throws java.io.IOException,
                       AutomationException

Updates an existing item in target style file.

Parameters:

item - A reference to a com.esri.arcgis.display.IStyleGalleryItem (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeItem

void removeItem(IStyleGalleryItem item)
                throws java.io.IOException,
                       AutomationException

Removes an item from the target style file.

Parameters:

item - A reference to a com.esri.arcgis.display.IStyleGalleryItem (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clear

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

Removes all styles from the Style Gallery.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadStyle

void loadStyle(java.lang.String fileName,
               java.lang.String className)
               throws java.io.IOException,
                      AutomationException

Loads a style from a file. If class is specified, only items in that class will be loaded.

Parameters:

fileName - The fileName (in)

className - The className (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveStyle

void saveStyle(java.lang.String fileName,
               java.lang.String styleSet,
               java.lang.String className)
               throws java.io.IOException,
                      AutomationException

Saves the specified style to a file. If class is specified, only items in that class will be saved.

Parameters:

fileName - The fileName (in)

styleSet - The styleSet (in)

className - The className (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

importStyle

void importStyle(java.lang.String fileName)
                 throws java.io.IOException,
                        AutomationException

Imports a style from a file other than a .style file.

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.