com.esri.arcgis.controls
Interface ISymbologyStyleClass

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISymbologyStyleClassProxy, SymbologyStyleClass

public interface ISymbologyStyleClass
extends java.io.Serializable

COM Interface 'ISymbologyStyleClass'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control SymbologyControl style classes.' 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	IIDa1afd241_58fd_4c2d_a258_93c505cca546
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addItem(IStyleGalleryItem item, int index) Adds an item to the SymbologyStyleClass.
IStyleGalleryItem	getItem(int index) Returns the item at the specified index in the SymbologyStyleClass.
int	getItemCount(java.lang.Object styleCategory) The number of items in the SymbologyStyleClass.
IStyleGalleryItem	getSelectedItem() Returns the selected item in the SymbologyStyleClass.
int	getSortDirection() The sort direction of the items in the SymbologyStyleClass.
java.lang.String	getStyleCategory() The style category used by the SymbologyStyleClass.
int	getStyleClass() The class of the symbols in the SymbologyStyleClass.
Picture	previewItem(IStyleGalleryItem item, int width, int height) Previews the specified item as a bitmap.
void	removeAll() Removes all items from the SymbologyStyleClass.
void	removeItem(int index) Removes the item at the specified index from the SymbologyStyleClass.
void	selectItem(int index) Sets the selected item in the SymbologyStyleClass.
void	setSortDirection(int direction) The sort direction of the items in the SymbologyStyleClass.
void	setStyleCategory(java.lang.String categoryName) The style category used by the SymbologyStyleClass.
void	unselectItem() Unsets the selected item in the SymbologyStyleClass.
void	update() Updates the contents of the SymbologyStyleClass.

Field Detail

IIDa1afd241_58fd_4c2d_a258_93c505cca546

static final int IIDa1afd241_58fd_4c2d_a258_93c505cca546

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

setStyleCategory

void setStyleCategory(java.lang.String categoryName)
                      throws java.io.IOException,
                             AutomationException

The style category used by the SymbologyStyleClass.

Parameters:

categoryName - The categoryName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyleCategory

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

The style category used by the SymbologyStyleClass.

Returns:

The categoryName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSortDirection

void setSortDirection(int direction)
                      throws java.io.IOException,
                             AutomationException

The sort direction of the items in the SymbologyStyleClass.

Parameters:

direction - A com.esri.arcgis.controls.esriSymbologySortDirection constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSortDirection

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

The sort direction of the items in the SymbologyStyleClass.

Returns:

A com.esri.arcgis.controls.esriSymbologySortDirection constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyleClass

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

The class of the symbols in the SymbologyStyleClass.

Returns:

A com.esri.arcgis.controls.esriSymbologyStyleClass constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemCount

int getItemCount(java.lang.Object styleCategory)
                 throws java.io.IOException,
                        AutomationException

The number of items in the SymbologyStyleClass.

Parameters:

styleCategory - A Variant (in, optional, pass null if not required)

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItem

IStyleGalleryItem getItem(int index)
                          throws java.io.IOException,
                                 AutomationException

Returns the item at the specified index in the SymbologyStyleClass.

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectItem

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

Sets the selected item in the SymbologyStyleClass.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unselectItem

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

Unsets the selected item in the SymbologyStyleClass.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

IStyleGalleryItem getSelectedItem()
                                  throws java.io.IOException,
                                         AutomationException

Returns the selected item in the SymbologyStyleClass.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addItem

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

Adds an item to the SymbologyStyleClass.

Parameters:

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

index - The index (in, optional, pass -1 if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeItem

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

Removes the item at the specified index from the SymbologyStyleClass.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all items from the SymbologyStyleClass.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

previewItem

Picture previewItem(IStyleGalleryItem item,
                    int width,
                    int height)
                    throws java.io.IOException,
                           AutomationException

Previews the specified item as a bitmap.

Parameters:

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

width - The width (in)

height - The height (in)

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

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

Updates the contents of the SymbologyStyleClass.

Throws:

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

AutomationException - If the ArcObject component throws an exception.