|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.interop.Dispatch com.esri.arcgis.controls.ISymbologyControlDefaultProxy
public class ISymbologyControlDefaultProxy
Provides access to members that control the SymbologyControl.
The ISymbologyControlDefault interface is the default dispatch interface that most development environments will automatically expose. For example, placing the SymbologyControl in a container will typically generate an object called SymbologyControl1. The properties and methods available directly on this object correspond to this interface, together with container specific properties and methods.
The ISymbologyControlDefault interface is a 'pure' dispatch interface, so can be extended with new properties and methods at future releases of ArcGIS. The methods and properties are identical to the highest numbered main interface on the SymbologyControl. For example, ISymbologySelectorDefault is equivalent to ISymbologyControl, but at future releases this could become ISymbologyControl2. By using the ISymbologySelectorDefault interface you are guaranteed to always have access to the latest SymbologyControl.
There is a small performance overhead in making calls through to a pure dispatch interface, but to avoid this you can QI to a specific interface. In some development environments it is not possible to QI directly on the control to other COM interfaces, because the control is contained within a wrapper object. Use the Object property to get the real control before performing the QI.
Field Summary | |
---|---|
boolean |
noncastable
|
Fields inherited from class com.esri.arcgis.interop.Dispatch |
---|
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef |
Constructor Summary | |
---|---|
|
ISymbologyControlDefaultProxy()
|
|
ISymbologyControlDefaultProxy(Object obj)
|
protected |
ISymbologyControlDefaultProxy(Object obj,
String iid)
|
Method Summary | |
---|---|
void |
aboutBox()
Displays a dialog of information about the SymbologyControl. |
void |
addListener(String iidStr,
Object theListener,
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 rhs1)
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. |
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. |
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(String fileName)
Loads a desktop style file into the SymbologyControl. |
void |
loadStyleFile(String fileName)
Loads a server style file into the SymbologyControl. |
void |
removeFile(String fileName)
Removes a file from the SymbologyControl. |
void |
removeListener(String iidStr,
Object theListener)
|
void |
setAppearance(int rhs1)
The appearance of the SymbologyControl. |
void |
setBackColor(int rhs1)
Background color of the SymbologyControl. |
void |
setBorderStyle(int rhs1)
The border style of the SymbologyControl. |
void |
setCustomProperty(Object rhs1)
A property to associate data with the SymbologyControl. |
void |
setDisplayStyle(int rhs1)
The display style of the SymbologyControl. |
void |
setKeyIntercept(int rhs1)
A property that specifies interception of key strokes that are normally handled by the container. |
void |
setMouseIconByRef(Picture rhs1)
Custom mouse icon used if MousePointer is 99. |
void |
setMousePointer(int rhs1)
The mouse pointer displayed over the SymbologyControl. |
void |
setShowContextMenu(boolean rhs1)
Indicates if the SymbologyControl displays a context menu. |
void |
setStyleClass(int rhs1)
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 |
---|
public boolean noncastable
Constructor Detail |
---|
public ISymbologyControlDefaultProxy()
public ISymbologyControlDefaultProxy(Object obj) throws IOException
IOException
protected ISymbologyControlDefaultProxy(Object obj, String iid) throws IOException
IOException
Method Detail |
---|
public void addListener(String iidStr, Object theListener, Object theSource) throws IOException
addListener
in class com.esri.arcgis.interop.Dispatch
IOException
public void removeListener(String iidStr, Object theListener) throws IOException
removeListener
in class com.esri.arcgis.interop.Dispatch
IOException
public void setBackColor(int rhs1) throws IOException, AutomationException
setBackColor
in interface ISymbologyControlDefault
rhs1
- The rhs1 (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getBackColor() throws IOException, AutomationException
Returns or sets the Background Color of the SymbologyControl. Internally the OLE_Color is stored as a long integer where the value may be calculated for any RGB combination as follows:
OLE_Color = (Red) + (Green * 256) + (Blue * 256 * 256)
Where Red, Green and Blue are Long Integers within the range 0 - 255.
getBackColor
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMousePointer(int rhs1) throws IOException, AutomationException
setMousePointer
in interface ISymbologyControlDefault
rhs1
- A com.esri.arcgis.controls.esriControlsMousePointer constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMousePointer() throws IOException, AutomationException
Use this property when you want to indicate changes in functionality as the mouse pointer passes over the SymbologyControl. The esriPointerArrowHourglass setting (11) is useful for indicating that the user should wait for a process or operation to finish.
getMousePointer
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMouseIconByRef(Picture rhs1) throws IOException, AutomationException
setMouseIconByRef
in interface ISymbologyControlDefault
rhs1
- A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Picture getMouseIcon() throws IOException, AutomationException
The MouseIcon property provides a custom icon that is used when the MousePointer property is set to esriPointerArrowHourglass (99).
In most development evironments the control's property pages can be used to load either a cursor (.cur) or icon (.ico) file. A cursor contains a custom 'hotspot' location and can be any size. The 'hotspot' location for an icon file defaults to the center of the icon. This property cannot be used to load animated cursor (.ani) files.
To programatically create an object implementing IPictureDisp there is the win32 function OleLoadPicture or helper methods depending on the development environment.
getMouseIcon
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBorderStyle(int rhs1) throws IOException, AutomationException
setBorderStyle
in interface ISymbologyControlDefault
rhs1
- A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getBorderStyle() throws IOException, AutomationException
Returns or sets the border style of a SymbologyControl. By default a border is drawn.
getBorderStyle
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void esri_setEnabled(boolean rhs1) throws IOException, AutomationException
esri_setEnabled
in interface ISymbologyControlDefault
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean esri_isEnabled() throws IOException, AutomationException
esri_isEnabled
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAppearance(int rhs1) throws IOException, AutomationException
setAppearance
in interface ISymbologyControlDefault
rhs1
- A com.esri.arcgis.controls.esriControlsAppearance constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getAppearance() throws IOException, AutomationException
Returns or sets the paint style of a SymbologyControl to either Flat or 3D. By default the appearance is flat.
getAppearance
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHWnd() throws IOException, AutomationException
The operating environment identifies each window, form and control in an application by assigning it a handle, or hWnd. Many ArcObjects methods and Windows API calls require the hWnd as an argument.
getHWnd
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void aboutBox() throws IOException, AutomationException
The AboutBox method causes a modal dialog box to display on top of the SymbologyControl, containing information about the version and creation date of the SymbologyControl as well as listing relevant legal and copyright information from ESRI.
aboutBox
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setStyleClass(int rhs1) throws IOException, AutomationException
setStyleClass
in interface ISymbologyControlDefault
rhs1
- A com.esri.arcgis.controls.esriSymbologyStyleClass constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getStyleClass() throws IOException, AutomationException
The SymbologyStyleClass currently displayed in the SymbologyControl. By default marker symbols are displayed.
The end user can set the StyleClass by interacting with the 'Style Class' context menu. The end user can display the 'Style Class' context menu by right clicking on the SymbologyControl when ShowContextMenu is true.
The OnStyleClassChanged event will fire when the StyleClass is set.
The following style classes are only supported with an ArcGIS for Desktop installation:
getStyleClass
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDisplayStyle(int rhs1) throws IOException, AutomationException
setDisplayStyle
in interface ISymbologyControlDefault
rhs1
- A com.esri.arcgis.controls.esriSymbologyDisplayStyle constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getDisplayStyle() throws IOException, AutomationException
Returns or sets the style the items are displayed in the SymbologyControl. By default the DisplayStyle is Icon.
esriDisplayStyleIcon
esriDisplayStyleSmallIcon
esriDisplayStyleReport
esriDisplayStyleList
getDisplayStyle
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setKeyIntercept(int rhs1) throws IOException, AutomationException
setKeyIntercept
in interface ISymbologyControlDefault
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getKeyIntercept() throws IOException, AutomationException
Returns or sets keys on the keyboard that will be intercepted by the SymbologyControl, triggering the OnKeyDown and OnKeyUp events when pressed. These keys are often hidden from the SymbologyControl by the development environment container. By default the KeyIntercept is set to esriKeyInterceptNone.
Many development environment containers use the up, down, left and right arrow keys to change control focus on a form. These keys can also be useful for navigating around the display. To intercept the arrow keys and the Tab key combine the enum values using a logical OR operation (esriKeyInterceptArrowKeys OR esriKeyInterceptTabKey, which is 1 OR 4 = 5).
getKeyIntercept
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getCustomProperty() throws IOException, AutomationException
Use the CustomProperty to associate any useful data with the SymbologyControl. This is similar to a 'Tag' property, and can be use to store strings, numbers and objects.
getCustomProperty
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCustomProperty(Object rhs1) throws IOException, AutomationException
setCustomProperty
in interface ISymbologyControlDefault
rhs1
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowContextMenu(boolean rhs1) throws IOException, AutomationException
setShowContextMenu
in interface ISymbologyControlDefault
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowContextMenu() throws IOException, AutomationException
Determines whether the 'Style Class' context menu will popup when the user right clicks on the control. This property is false by default.
The OnStyleClassChanged event will fire if the user interactively sets the StyleClass property using the 'Style Class' context menu.
isShowContextMenu
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getObject() throws IOException, AutomationException
In some development environments it is not possible to query interface directly on the control to other COM interfaces, beacuse the control is contained within a wrapper object. To get the real control use the Object property.
getObject
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IStyleGalleryItem hitTest(int x, int y) throws IOException, AutomationException
Returns the item at the specified x and y coordinates (in pixels). If no item is found, returns Nothing.
hitTest
in interface ISymbologyControlDefault
x
- The x (in)y
- The y (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void loadStyleFile(String fileName) throws IOException, AutomationException
Loads the contents of the specified server style file (*.ServerStyle) into the SymbologyControl. Each ServerStyleGalleryItem within the server style file is added to a SymbologyStyleClass based on its type. For example, a SimpleFillSymbol will be added to the esriStyleClassFillSymbols SymbologyStyleClass.
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 StyleClass or when the SymbologyStyleClass is being accessed programmatically. To force items to be loaded into a SymbologyStyleClass, when it is not the current StyleClass use the ISymbologyStyleClass::Update method.
Passing the same server style file to the LoadStyleFile method multiple times within the lifetime of an application, causes the contents of the server style file to be re-loaded into the SymbologyControl.
Server Styles are collections of symbols and map elements that are often grouped by functionality. For example, symbols and map elements used by the transportation industry maybe grouped into Transportation Server Style.
Server Styles are stored in files that have a .ServerStyle extension. ESRI provides several styles for you to use out of the box. These styles are found under \\install_location\ArcGIS\Styles. You will find commonly used symbols and map elements in ESRI.ServerStyle, and more domain specific style items in relevantly named .ServerStyle files (for example, Transportation.ServerStyle).
A style is composed of several style items. These style items provide access to individual map elements and symbols. Style items are organized into style classes, which are types of style items. A style class may have several groups of items organized into categories. For example, Precipitation is style item that belongs to the Color Ramps style class and the Default Ramps category.
loadStyleFile
in interface ISymbologyControlDefault
fileName
- The fileName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void loadDesktopStyleFile(String fileName) throws IOException, AutomationException
Loads the contents of the specified style file (*.Style) into the SymbologyControl. Where possible, always use the LoadStyleFile method to load the contents of server style files (*.ServerStyle) into the SymbologyControl, as style files are only supported with an ArcGIS for Desktop installation.
Each StyleGalleryItem within the style file is added to a SymbologyStyleClass based on its type. For example, a SimpleFillSymbol will be added to the esriStyleClassFillSymbols SymbologyStyleClass.
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 StyleClass, or when the SymbologyStyleClass is being accessed programmatically. To force items to be loaded into a SymbologyStyleClass when it is not the current StyleClass, use the ISymbologyStyleClass::Update method.
Passing the same style file to the LoadDesktopStyleFile method multiple times within the lifetime of an application, causes the contents of the style file to reload into the SymbologyControl.
A 'desktop' Style file is similar to a Server Style file, except is has a .Style extension rather than a .ServerStyle extension. Style files are available to ArcGIS for Desktop products only, whereas Server Style files are available to all ArcGIS products.
loadDesktopStyleFile
in interface ISymbologyControlDefault
fileName
- The fileName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISymbologyStyleClass getStyleClass2(int styleClass) throws IOException, AutomationException
getStyleClass2
in interface ISymbologyControlDefault
styleClass
- A com.esri.arcgis.controls.esriSymbologyStyleClass constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeFile(String fileName) throws IOException, AutomationException
Removes the contents of the specified server style file (*.ServerStyle) or style file (*.Style) from the SymbologyControl. Corresponding items are removed from each SymbologyStyleClass.
removeFile
in interface ISymbologyControlDefault
fileName
- The fileName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clear() throws IOException, AutomationException
Clears all items from the SymbologyControl. Items are removed from each SymbologyStyleClass regardless of whether they were loaded using the LoadStyleFile, LoadDesktopStyleFile or ISymbologyStyleClass::AddItem methods.
clear
in interface ISymbologyControlDefault
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |