com.esri.arcgis.controls
Class ISymbologyControlProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.controls.ISymbologyControlProxy
All Implemented Interfaces:
ISymbologyControl, java.io.Externalizable, java.io.Serializable

public class ISymbologyControlProxy
extends com.esri.arcgis.interop.Dispatch
implements ISymbologyControl, java.io.Serializable

Internal use class Proxy for COM Interface 'ISymbologyControl'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control 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
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.controls.ISymbologyControl
DISPID__501_GET_NAME, DISPID__501_PUT_NAME, DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_GET_NAME, DISPID_1_PUT_NAME, DISPID_10_NAME, DISPID_11_NAME, DISPID_12_NAME, DISPID_2_GET_NAME, DISPID_2_PUT_NAME, DISPID_3_GET_NAME, DISPID_3_PUT_NAME, DISPID_4_GET_NAME, DISPID_4_PUT_NAME, DISPID_5_GET_NAME, DISPID_5_PUT_NAME, DISPID_6_GET_NAME, DISPID_7_NAME, DISPID_8_NAME, DISPID_9_NAME, IID, IID0a164b9f_a572_4c93_8be9_b7d0ad33bb0e
 
Constructor Summary
  ISymbologyControlProxy()
          For internal use only
  ISymbologyControlProxy(java.lang.Object obj)
           
protected ISymbologyControlProxy(java.lang.Object obj, java.lang.String iid)
           
  ISymbologyControlProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected ISymbologyControlProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void aboutBox()
          Displays a dialog of information about the SymbologyControl.
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 void clear()
          Clears all symbols and files from the SymbologyControl.
 boolean esri_isEnabled()
          Indicates whether the SymbologyControl can respond to user generated events.
 void esri_setEnabled(boolean enabled)
          Indicates whether the SymbologyControl can respond to user generated events.
 int getAppearance()
          The appearance of the SymbologyControl.
 int getBackColor()
          Background color of the SymbologyControl.
 int getBorderStyle()
          The border style of the SymbologyControl.
 java.lang.Object getCustomProperty()
          A property to associate data with the SymbologyControl.
 int getDisplayStyle()
          The display style of the SymbologyControl.
 int getHWnd()
          Handle to the window associated with the SymbologyControl.
 int getKeyIntercept()
          A property that specifies interception of key strokes that are normally handled by the container.
 Picture getMouseIcon()
          Custom mouse icon used if MousePointer is 99.
 int getMousePointer()
          The mouse pointer displayed over the SymbologyControl.
 java.lang.Object getObject()
          A property that returns the underlying control.
 int getStyleClass()
          The style class used by the SymbologyControl.
 ISymbologyStyleClass getStyleClass2(int styleClass)
          Returns the specified style class from the SymbologyControl.
 IStyleGalleryItem hitTest(int x, int y)
          Returns the item at the specified x and y coordinates.
 boolean isShowContextMenu()
          Indicates if the SymbologyControl displays a context menu.
 void loadDesktopStyleFile(java.lang.String fileName)
          Loads a desktop style file into the SymbologyControl.
 void loadStyleFile(java.lang.String fileName)
          Loads a server style file into the SymbologyControl.
 void removeFile(java.lang.String fileName)
          Removes a file from the SymbologyControl.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 void setAppearance(int appearance)
          The appearance of the SymbologyControl.
 void setBackColor(int backColor)
          Background color of the SymbologyControl.
 void setBorderStyle(int borderStyle)
          The border style of the SymbologyControl.
 void setCustomProperty(java.lang.Object property)
          A property to associate data with the SymbologyControl.
 void setDisplayStyle(int style)
          The display style of the SymbologyControl.
 void setKeyIntercept(int intercept)
          A property that specifies interception of key strokes that are normally handled by the container.
 void setMouseIconByRef(Picture mouseIcon)
          Custom mouse icon used if MousePointer is 99.
 void setMousePointer(int mousePointer)
          The mouse pointer displayed over the SymbologyControl.
 void setShowContextMenu(boolean show)
          Indicates if the SymbologyControl displays a context menu.
 void setStyleClass(int styleClass)
          The style class used by the SymbologyControl.
 
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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

ISymbologyControlProxy

public ISymbologyControlProxy(java.lang.String CLSID,
                              java.lang.String host,
                              com.esri.arcgis.interop.AuthInfo authInfo)
                       throws java.net.UnknownHostException,
                              java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

ISymbologyControlProxy

public ISymbologyControlProxy()
For internal use only


ISymbologyControlProxy

public ISymbologyControlProxy(java.lang.Object obj)
                       throws java.io.IOException
Throws:
java.io.IOException

ISymbologyControlProxy

protected ISymbologyControlProxy(java.lang.Object obj,
                                 java.lang.String iid)
                          throws java.io.IOException
Throws:
java.io.IOException

ISymbologyControlProxy

protected ISymbologyControlProxy(java.lang.String CLSID,
                                 java.lang.String iid,
                                 java.lang.String host,
                                 com.esri.arcgis.interop.AuthInfo authInfo)
                          throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

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

removeListener

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

setBackColor

public void setBackColor(int backColor)
                  throws java.io.IOException,
                         AutomationException
Background color of the SymbologyControl.

Specified by:
setBackColor in interface ISymbologyControl
Parameters:
backColor - The backColor (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackColor

public int getBackColor()
                 throws java.io.IOException,
                        AutomationException
Background color of the SymbologyControl.

Specified by:
getBackColor in interface ISymbologyControl
Returns:
The backColor (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int mousePointer)
                     throws java.io.IOException,
                            AutomationException
The mouse pointer displayed over the SymbologyControl.

Specified by:
setMousePointer in interface ISymbologyControl
Parameters:
mousePointer - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMousePointer

public int getMousePointer()
                    throws java.io.IOException,
                           AutomationException
The mouse pointer displayed over the SymbologyControl.

Specified by:
getMousePointer in interface ISymbologyControl
Returns:
A com.esri.arcgis.controls.esriControlsMousePointer constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

public void setMouseIconByRef(Picture mouseIcon)
                       throws java.io.IOException,
                              AutomationException
Custom mouse icon used if MousePointer is 99.

Specified by:
setMouseIconByRef in interface ISymbologyControl
Parameters:
mouseIcon - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMouseIcon

public Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException
Custom mouse icon used if MousePointer is 99.

Specified by:
getMouseIcon in interface ISymbologyControl
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.

setBorderStyle

public void setBorderStyle(int borderStyle)
                    throws java.io.IOException,
                           AutomationException
The border style of the SymbologyControl.

Specified by:
setBorderStyle in interface ISymbologyControl
Parameters:
borderStyle - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBorderStyle

public int getBorderStyle()
                   throws java.io.IOException,
                          AutomationException
The border style of the SymbologyControl.

Specified by:
getBorderStyle in interface ISymbologyControl
Returns:
A com.esri.arcgis.controls.esriControlsBorderStyle constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

public void esri_setEnabled(boolean enabled)
                     throws java.io.IOException,
                            AutomationException
Indicates whether the SymbologyControl can respond to user generated events.

Specified by:
esri_setEnabled in interface ISymbologyControl
Parameters:
enabled - The enabled (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

public boolean esri_isEnabled()
                       throws java.io.IOException,
                              AutomationException
Indicates whether the SymbologyControl can respond to user generated events.

Specified by:
esri_isEnabled in interface ISymbologyControl
Returns:
The enabled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int appearance)
                   throws java.io.IOException,
                          AutomationException
The appearance of the SymbologyControl.

Specified by:
setAppearance in interface ISymbologyControl
Parameters:
appearance - A com.esri.arcgis.controls.esriControlsAppearance constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAppearance

public int getAppearance()
                  throws java.io.IOException,
                         AutomationException
The appearance of the SymbologyControl.

Specified by:
getAppearance in interface ISymbologyControl
Returns:
A com.esri.arcgis.controls.esriControlsAppearance constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException
Handle to the window associated with the SymbologyControl.

Specified by:
getHWnd in interface ISymbologyControl
Returns:
The hWnd
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

aboutBox

public void aboutBox()
              throws java.io.IOException,
                     AutomationException
Displays a dialog of information about the SymbologyControl.

Specified by:
aboutBox in interface ISymbologyControl
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStyleClass

public void setStyleClass(int styleClass)
                   throws java.io.IOException,
                          AutomationException
The style class used by the SymbologyControl.

Specified by:
setStyleClass in interface ISymbologyControl
Parameters:
styleClass - A com.esri.arcgis.controls.esriSymbologyStyleClass constant (in)
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 style class used by the SymbologyControl.

Specified by:
getStyleClass in interface ISymbologyControl
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.

setDisplayStyle

public void setDisplayStyle(int style)
                     throws java.io.IOException,
                            AutomationException
The display style of the SymbologyControl.

Specified by:
setDisplayStyle in interface ISymbologyControl
Parameters:
style - A com.esri.arcgis.controls.esriSymbologyDisplayStyle constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayStyle

public int getDisplayStyle()
                    throws java.io.IOException,
                           AutomationException
The display style of the SymbologyControl.

Specified by:
getDisplayStyle in interface ISymbologyControl
Returns:
A com.esri.arcgis.controls.esriSymbologyDisplayStyle constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int intercept)
                     throws java.io.IOException,
                            AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:
setKeyIntercept in interface ISymbologyControl
Parameters:
intercept - The intercept (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

public int getKeyIntercept()
                    throws java.io.IOException,
                           AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:
getKeyIntercept in interface ISymbologyControl
Returns:
The intercept
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException
A property to associate data with the SymbologyControl.

Specified by:
getCustomProperty in interface ISymbologyControl
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object property)
                       throws java.io.IOException,
                              AutomationException
A property to associate data with the SymbologyControl.

Specified by:
setCustomProperty in interface ISymbologyControl
Parameters:
property - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowContextMenu

public void setShowContextMenu(boolean show)
                        throws java.io.IOException,
                               AutomationException
Indicates if the SymbologyControl displays a context menu.

Specified by:
setShowContextMenu in interface ISymbologyControl
Parameters:
show - The show (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowContextMenu

public boolean isShowContextMenu()
                          throws java.io.IOException,
                                 AutomationException
Indicates if the SymbologyControl displays a context menu.

Specified by:
isShowContextMenu in interface ISymbologyControl
Returns:
The show
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObject

public java.lang.Object getObject()
                           throws java.io.IOException,
                                  AutomationException
A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Specified by:
getObject in interface ISymbologyControl
Returns:
A reference to another Automation Object (IDispatch)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hitTest

public IStyleGalleryItem hitTest(int x,
                                 int y)
                          throws java.io.IOException,
                                 AutomationException
Returns the item at the specified x and y coordinates.

Specified by:
hitTest in interface ISymbologyControl
Parameters:
x - The x (in)
y - The y (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.

loadStyleFile

public void loadStyleFile(java.lang.String fileName)
                   throws java.io.IOException,
                          AutomationException
Loads a server style file into the SymbologyControl.

Specified by:
loadStyleFile in interface ISymbologyControl
Parameters:
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadDesktopStyleFile

public void loadDesktopStyleFile(java.lang.String fileName)
                          throws java.io.IOException,
                                 AutomationException
Loads a desktop style file into the SymbologyControl.

Specified by:
loadDesktopStyleFile in interface ISymbologyControl
Parameters:
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStyleClass2

public ISymbologyStyleClass getStyleClass2(int styleClass)
                                    throws java.io.IOException,
                                           AutomationException
Returns the specified style class from the SymbologyControl.

Specified by:
getStyleClass2 in interface ISymbologyControl
Parameters:
styleClass - A com.esri.arcgis.controls.esriSymbologyStyleClass constant (in)
Returns:
A reference to a com.esri.arcgis.controls.ISymbologyStyleClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeFile

public void removeFile(java.lang.String fileName)
                throws java.io.IOException,
                       AutomationException
Removes a file from the SymbologyControl.

Specified by:
removeFile in interface ISymbologyControl
Parameters:
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException
Clears all symbols and files from the SymbologyControl.

Specified by:
clear in interface ISymbologyControl
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.