com.esri.arcgis.controls
Interface ISymbologyControl

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISymbologyControlProxy, SymbologyBean, SymbologyControl

public interface ISymbologyControl
extends java.io.Serializable

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 =

Field Summary

static java.lang.String	DISPID__501_GET_NAME
static java.lang.String	DISPID__501_PUT_NAME
static java.lang.String	DISPID__504_GET_NAME
static java.lang.String	DISPID__504_PUT_NAME
static java.lang.String	DISPID__514_GET_NAME
static java.lang.String	DISPID__514_PUT_NAME
static java.lang.String	DISPID__515_GET_NAME
static java.lang.String	DISPID__520_GET_NAME
static java.lang.String	DISPID__520_PUT_NAME
static java.lang.String	DISPID__521_GET_NAME
static java.lang.String	DISPID__521_PUT_NAME
static java.lang.String	DISPID__522_GET_NAME
static java.lang.String	DISPID__522_PUTREF_NAME
static java.lang.String	DISPID__552_NAME
static java.lang.String	DISPID_1_GET_NAME
static java.lang.String	DISPID_1_PUT_NAME
static java.lang.String	DISPID_10_NAME
static java.lang.String	DISPID_11_NAME
static java.lang.String	DISPID_12_NAME
static java.lang.String	DISPID_2_GET_NAME
static java.lang.String	DISPID_2_PUT_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_3_PUT_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_4_PUT_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_5_PUT_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	DISPID_7_NAME
static java.lang.String	DISPID_8_NAME
static java.lang.String	DISPID_9_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID0a164b9f_a572_4c93_8be9_b7d0ad33bb0e
static int	xxDummy Deprecated. Internal use only

Method Summary

void	aboutBox() Displays a dialog of information about the SymbologyControl.
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	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.

Field Detail

IID0a164b9f_a572_4c93_8be9_b7d0ad33bb0e

static final int IID0a164b9f_a572_4c93_8be9_b7d0ad33bb0e

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

DISPID__501_PUT_NAME

static final java.lang.String DISPID__501_PUT_NAME

See Also:

Constant Field Values

DISPID__501_GET_NAME

static final java.lang.String DISPID__501_GET_NAME

See Also:

Constant Field Values

DISPID__521_PUT_NAME

static final java.lang.String DISPID__521_PUT_NAME

See Also:

Constant Field Values

DISPID__521_GET_NAME

static final java.lang.String DISPID__521_GET_NAME

See Also:

Constant Field Values

DISPID__522_PUTREF_NAME

static final java.lang.String DISPID__522_PUTREF_NAME

See Also:

Constant Field Values

DISPID__522_GET_NAME

static final java.lang.String DISPID__522_GET_NAME

See Also:

Constant Field Values

DISPID__504_PUT_NAME

static final java.lang.String DISPID__504_PUT_NAME

See Also:

Constant Field Values

DISPID__504_GET_NAME

static final java.lang.String DISPID__504_GET_NAME

See Also:

Constant Field Values

DISPID__514_PUT_NAME

static final java.lang.String DISPID__514_PUT_NAME

See Also:

Constant Field Values

DISPID__514_GET_NAME

static final java.lang.String DISPID__514_GET_NAME

See Also:

Constant Field Values

DISPID__520_PUT_NAME

static final java.lang.String DISPID__520_PUT_NAME

See Also:

Constant Field Values

DISPID__520_GET_NAME

static final java.lang.String DISPID__520_GET_NAME

See Also:

Constant Field Values

DISPID__515_GET_NAME

static final java.lang.String DISPID__515_GET_NAME

See Also:

Constant Field Values

DISPID__552_NAME

static final java.lang.String DISPID__552_NAME

See Also:

Constant Field Values

DISPID_1_PUT_NAME

static final java.lang.String DISPID_1_PUT_NAME

See Also:

Constant Field Values

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME

See Also:

Constant Field Values

DISPID_2_PUT_NAME

static final java.lang.String DISPID_2_PUT_NAME

See Also:

Constant Field Values

DISPID_2_GET_NAME

static final java.lang.String DISPID_2_GET_NAME

See Also:

Constant Field Values

DISPID_3_PUT_NAME

static final java.lang.String DISPID_3_PUT_NAME

See Also:

Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_4_PUT_NAME

static final java.lang.String DISPID_4_PUT_NAME

See Also:

Constant Field Values

DISPID_5_PUT_NAME

static final java.lang.String DISPID_5_PUT_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_7_NAME

static final java.lang.String DISPID_7_NAME

See Also:

Constant Field Values

DISPID_8_NAME

static final java.lang.String DISPID_8_NAME

See Also:

Constant Field Values

DISPID_9_NAME

static final java.lang.String DISPID_9_NAME

See Also:

Constant Field Values

DISPID_10_NAME

static final java.lang.String DISPID_10_NAME

See Also:

Constant Field Values

DISPID_11_NAME

static final java.lang.String DISPID_11_NAME

See Also:

Constant Field Values

DISPID_12_NAME

static final java.lang.String DISPID_12_NAME

See Also:

Constant Field Values

Method Detail

setBackColor

void setBackColor(int backColor)
                  throws java.io.IOException,
                         AutomationException

Background color of the SymbologyControl.

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

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

Background color of the SymbologyControl.

Returns:

The backColor (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMousePointer

void setMousePointer(int mousePointer)
                     throws java.io.IOException,
                            AutomationException

The mouse pointer displayed over the SymbologyControl.

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

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

The mouse pointer displayed over the SymbologyControl.

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

void setMouseIconByRef(Picture mouseIcon)
                       throws java.io.IOException,
                              AutomationException

Custom mouse icon used if MousePointer is 99.

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

Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException

Custom mouse icon used if MousePointer is 99.

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

void setBorderStyle(int borderStyle)
                    throws java.io.IOException,
                           AutomationException

The border style of the SymbologyControl.

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

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

The border style of the SymbologyControl.

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

void esri_setEnabled(boolean enabled)
                     throws java.io.IOException,
                            AutomationException

Indicates whether the SymbologyControl can respond to user generated events.

Parameters:

enabled - The enabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

boolean esri_isEnabled()
                       throws java.io.IOException,
                              AutomationException

Indicates whether the SymbologyControl can respond to user generated events.

Returns:

The enabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAppearance

void setAppearance(int appearance)
                   throws java.io.IOException,
                          AutomationException

The appearance of the SymbologyControl.

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

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

The appearance of the SymbologyControl.

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

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

Handle to the window associated with the SymbologyControl.

Returns:

The hWnd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

aboutBox

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

Displays a dialog of information about the SymbologyControl.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStyleClass

void setStyleClass(int styleClass)
                   throws java.io.IOException,
                          AutomationException

The style class used by the SymbologyControl.

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

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

The style class used by the SymbologyControl.

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

void setDisplayStyle(int style)
                     throws java.io.IOException,
                            AutomationException

The display style of the SymbologyControl.

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

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

The display style of the SymbologyControl.

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

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.

Parameters:

intercept - The intercept (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

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.

Returns:

The intercept

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

A property to associate data with the SymbologyControl.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(java.lang.Object property)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with the SymbologyControl.

Parameters:

property - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowContextMenu

void setShowContextMenu(boolean show)
                        throws java.io.IOException,
                               AutomationException

Indicates if the SymbologyControl displays a context menu.

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowContextMenu

boolean isShowContextMenu()
                          throws java.io.IOException,
                                 AutomationException

Indicates if the SymbologyControl displays a context menu.

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObject

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.

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

IStyleGalleryItem hitTest(int x,
                          int y)
                          throws java.io.IOException,
                                 AutomationException

Returns the item at the specified x and y coordinates.

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

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

Loads a server style file into the SymbologyControl.

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadDesktopStyleFile

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

Loads a desktop style file into the SymbologyControl.

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyleClass2

ISymbologyStyleClass getStyleClass2(int styleClass)
                                    throws java.io.IOException,
                                           AutomationException

Returns the specified style class from the SymbologyControl.

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

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

Removes a file from the SymbologyControl.

Parameters:

fileName - The fileName (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

Clears all symbols and files from the SymbologyControl.

Throws:

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

AutomationException - If the ArcObject component throws an exception.