com.esri.arcgis.controls
Class SymbologyStyleClass

java.lang.Object
  com.esri.arcgis.controls.SymbologyStyleClass

All Implemented Interfaces:

ISymbologyStyleClass, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class SymbologyStyleClass
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISymbologyStyleClass, ISupportErrorInfo

COM Class 'SymbologyStyleClass'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'Symbology StyleClass used by the SymbologyControl.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.controls.ISymbologyStyleClass

IID, IIDa1afd241_58fd_4c2d_a258_93c505cca546, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

SymbologyStyleClass(java.lang.Object obj)
Construct a SymbologyStyleClass using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addItem(IStyleGalleryItem item, int index) Adds an item to the SymbologyStyleClass.
boolean	equals(java.lang.Object o) Compare this object with another
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
Picture	previewItem(IStyleGalleryItem item, int width, int height) Previews the specified item as a bitmap.
void	release() Release a SymbologyStyleClass.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SymbologyStyleClass

public SymbologyStyleClass(java.lang.Object obj)
                    throws java.io.IOException

Construct a SymbologyStyleClass using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SymbologyStyleClass.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
SymbologyStyleClass o = (SymbologyStyleClass)obj; // will not work

SymbologyStyleClass o = new SymbologyStyleClass(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems SymbologyStyleClass theSymbologyStyleClass = (SymbologyStyleClass) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a SymbologyStyleClass.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setStyleCategory

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

The style category used by the SymbologyStyleClass.

Specified by:

setStyleCategory in interface ISymbologyStyleClass

Parameters:

categoryName - The categoryName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyleCategory

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

The style category used by the SymbologyStyleClass.

Specified by:

getStyleCategory in interface ISymbologyStyleClass

Returns:

The categoryName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSortDirection

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

The sort direction of the items in the SymbologyStyleClass.

Specified by:

setSortDirection in interface ISymbologyStyleClass

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

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

The sort direction of the items in the SymbologyStyleClass.

Specified by:

getSortDirection in interface ISymbologyStyleClass

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

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

The class of the symbols in the SymbologyStyleClass.

Specified by:

getStyleClass in interface ISymbologyStyleClass

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

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

The number of items in the SymbologyStyleClass.

Specified by:

getItemCount in interface ISymbologyStyleClass

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

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

Returns the item at the specified index in the SymbologyStyleClass.

Specified by:

getItem in interface ISymbologyStyleClass

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

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

Sets the selected item in the SymbologyStyleClass.

Specified by:

selectItem in interface ISymbologyStyleClass

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unselectItem

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

Unsets the selected item in the SymbologyStyleClass.

Specified by:

unselectItem in interface ISymbologyStyleClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

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

Returns the selected item in the SymbologyStyleClass.

Specified by:

getSelectedItem in interface ISymbologyStyleClass

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

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

Adds an item to the SymbologyStyleClass.

Specified by:

addItem in interface ISymbologyStyleClass

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

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

Removes the item at the specified index from the SymbologyStyleClass.

Specified by:

removeItem in interface ISymbologyStyleClass

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all items from the SymbologyStyleClass.

Specified by:

removeAll in interface ISymbologyStyleClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

previewItem

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

Previews the specified item as a bitmap.

Specified by:

previewItem in interface ISymbologyStyleClass

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

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

Updates the contents of the SymbologyStyleClass.

Specified by:

update in interface ISymbologyStyleClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.