com.esri.arcgis.controls
Class ISymbologyStyleClassProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.controls.ISymbologyStyleClassProxy
All Implemented Interfaces:
ISymbologyStyleClass, Externalizable, Serializable

public class ISymbologyStyleClassProxy
extends com.esri.arcgis.interop.Dispatch
implements ISymbologyStyleClass, Serializable

Provides access to members that control SymbologyControl style classes.

Description

The ISymbologyControl interface provides properties and methods for managing the individual symbology items within a SymbologyStyleClass.

Product Availability

Available with ArcGIS Engine.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  ISymbologyStyleClassProxy()
           
  ISymbologyStyleClassProxy(Object obj)
           
protected ISymbologyStyleClassProxy(Object obj, String iid)
           
 
Method Summary
 void addItem(IStyleGalleryItem item, int index)
          Adds an item to the SymbologyStyleClass.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 IStyleGalleryItem getItem(int index)
          Returns the item at the specified index in the SymbologyStyleClass.
 int getItemCount(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.
 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 readExternal(ObjectInput in)
           
 void removeAll()
          Removes all items from the SymbologyStyleClass.
 void removeItem(int index)
          Removes the item at the specified index from the SymbologyStyleClass.
 void removeListener(String iidStr, Object theListener)
           
 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(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.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ISymbologyStyleClassProxy

public ISymbologyStyleClassProxy()

ISymbologyStyleClassProxy

public ISymbologyStyleClassProxy(Object obj)
                          throws IOException
Throws:
IOException

ISymbologyStyleClassProxy

protected ISymbologyStyleClassProxy(Object obj,
                                    String iid)
                             throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

setStyleCategory

public void setStyleCategory(String categoryName)
                      throws IOException,
                             AutomationException
The style category used by the SymbologyStyleClass.

Product Availability

Available with ArcGIS Engine.

Specified by:
setStyleCategory in interface ISymbologyStyleClass
Parameters:
categoryName - The categoryName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStyleCategory

public String getStyleCategory()
                        throws IOException,
                               AutomationException
The style category used by the SymbologyStyleClass.

Description

The IStyleGalleryItem::Category used to filter the items displayed within a SymbologyStyleClass. The StyleCategory is case sensitive. By default the StyleCategory is an empty string and indicates that all items are displayed.

Product Availability

Available with ArcGIS Engine.

Specified by:
getStyleCategory in interface ISymbologyStyleClass
Returns:
The categoryName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSortDirection

public void setSortDirection(int direction)
                      throws IOException,
                             AutomationException
The sort direction of the items in the SymbologyStyleClass.

Product Availability

Available with ArcGIS Engine.

Specified by:
setSortDirection in interface ISymbologyStyleClass
Parameters:
direction - A com.esri.arcgis.controls.esriSymbologySortDirection constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSortDirection

public int getSortDirection()
                     throws IOException,
                            AutomationException
The sort direction of the items in the SymbologyStyleClass.

Description

The sort direction used to display the items in the SymbologyControl. By default there is no SortDirection.

Product Availability

Available with ArcGIS Engine.

Specified by:
getSortDirection in interface ISymbologyStyleClass
Returns:
A com.esri.arcgis.controls.esriSymbologySortDirection constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStyleClass

public int getStyleClass()
                  throws IOException,
                         AutomationException
The class of the symbols in the SymbologyStyleClass.

Description

Returns the StyleClass of the SymbologyStyleClass.

Product Availability

Available with ArcGIS Engine.

Specified by:
getStyleClass in interface ISymbologyStyleClass
Returns:
A com.esri.arcgis.controls.esriSymbologyStyleClass constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemCount

public int getItemCount(Object styleCategory)
                 throws IOException,
                        AutomationException
The number of items in the SymbologyStyleClass.

Product Availability

Available with ArcGIS Engine.

Specified by:
getItemCount in interface ISymbologyStyleClass
Parameters:
styleCategory - A Variant (in, optional, pass null if not required)
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItem

public IStyleGalleryItem getItem(int index)
                          throws IOException,
                                 AutomationException
Returns the item at the specified index in the SymbologyStyleClass.

Description

Returns the item at the specified index in the SymbologyStyleClass. Typically the item is a ServerStyleGalleryItem .

Product Availability

Available with ArcGIS Engine.

Specified by:
getItem in interface ISymbologyStyleClass
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.IStyleGalleryItem
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectItem

public void selectItem(int index)
                throws IOException,
                       AutomationException
Sets the selected item in the SymbologyStyleClass.

Description

Selects the item at the specified index in the SymbologyStyleClass. An item can also be selected interactively by the end user clicking on an item in the SymbologyControl.

Selecting an item triggers the OnItemSelected event.

Product Availability

Available with ArcGIS Engine.

Specified by:
selectItem in interface ISymbologyStyleClass
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unselectItem

public void unselectItem()
                  throws IOException,
                         AutomationException
Unsets the selected item in the SymbologyStyleClass.

Description

Unselects the item selected in the SymbologyStyleClass.

Product Availability

Available with ArcGIS Engine.

Specified by:
unselectItem in interface ISymbologyStyleClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedItem

public IStyleGalleryItem getSelectedItem()
                                  throws IOException,
                                         AutomationException
Returns the selected item in the SymbologyStyleClass.

Description

Returns the selected item in the SymbologyStyleClass. If no item is selected Nothing is returned.

An item can be selected programmatically using the SelectItem method, or interactively by the end user clicking on an item in the SymbologyControl.

Product Availability

Available with ArcGIS Engine.

Specified by:
getSelectedItem in interface ISymbologyStyleClass
Returns:
A reference to a com.esri.arcgis.display.IStyleGalleryItem
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addItem

public void addItem(IStyleGalleryItem item,
                    int index)
             throws IOException,
                    AutomationException
Adds an item to the SymbologyStyleClass.

Description

Adds the specified item to the SymbologyStyleClass at the specified index. By default the index is -1 and represents the end of the item collection. Specify the item as a ServerStyleGalleryItem.

Product Availability

Available with ArcGIS Engine.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeItem

public void removeItem(int index)
                throws IOException,
                       AutomationException
Removes the item at the specified index from the SymbologyStyleClass.

Description

Removes the item at the specified index from the SymbologyStyleClass.

Product Availability

Available with ArcGIS Engine.

Specified by:
removeItem in interface ISymbologyStyleClass
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException
Removes all items from the SymbologyStyleClass.

Description

Removes all items from the SymbologyStyleClass.

Product Availability

Available with ArcGIS Engine.

Specified by:
removeAll in interface ISymbologyStyleClass
Throws:
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 IOException,
                           AutomationException
Previews the specified item as a bitmap.

Description

Returns a picture implementing IPictureDisp of the specified item. Use the method to display a preview of the item in another control, such as a PictureBox.

Product Availability

Available with ArcGIS Engine.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws IOException,
                   AutomationException
Updates the contents of the SymbologyStyleClass.

Description

Forces items to be loaded into the SymbologyStyleClass.

When the contents of a server style file are loaded into the SymbologyControl with the ISymbologyControl::LoadStyleFile method, items are 'demand loaded' to the end of a SymbologyStyleClass item collection. This is done to increase performance and means items are only loaded into a SymbologyStyleClass when it is the current ISymbologyControl::StyleClass.

To increase the speed that items display themselves within the SymbologyControl, the Update method can be used to force items to be loaded into a SymbologyStyleClass, when it is not the current ISymbologyControl::StyleClass.

Product Availability

Available with ArcGIS Engine.

Specified by:
update in interface ISymbologyStyleClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException