com.esri.arcgis.arcmapui
Class QueryAttributes

java.lang.Object
  com.esri.arcgis.arcmapui.QueryAttributes

All Implemented Interfaces:

IModelessQueryAttributes, IQueryAttributes, IObjectClassSchemaEvents, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class QueryAttributes
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IQueryAttributes, IModelessQueryAttributes, IObjectClassSchemaEvents

Display query attribute dialog in Mx.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

QueryAttributes()
Constructs a QueryAttributes using ArcGIS Engine.

QueryAttributes(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
QueryAttributes theQueryAttributes = (QueryAttributes) obj;

Method Summary

void	doModal(int parentHWnd) Shows attribute query window in a modal state.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCombinationMethod() CombinationMethod on form.
ILayer	getLayer() Layer selected by the user.
IQueryFilter	getQueryFilter() Provide a QueryFilter after form has been executed.
int	hashCode() the hashcode for this object
void	onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent) This event is fired when a new field is added to the object class.
void	onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent) This event is fired when the behavior class for the object class changes.
void	onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent) This event is fired when a field is deleted from the object class.
void	refresh() Refreshes the attribute query window when it's in a modeless state.
void	setApplicationByRef(Object rhs1) Provides the window with a reference to the application.
void	setCombinationMethod(int pMethod) CombinationMethod on form.
void	setExpression(String rhs1) Default expression.
void	setLayerByRef(ILayer ppLayer) Layer selected by the user.
void	setSelectFeaturesInLayerOnOK(boolean rhs1) When the user presses OK, select features.
void	show(int parentHWnd) Shows attribute query window in a modeless state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

QueryAttributes

public QueryAttributes()
                throws IOException,
                       UnknownHostException

Constructs a QueryAttributes using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

QueryAttributes

public QueryAttributes(Object obj)
                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
QueryAttributes theQueryAttributes = (QueryAttributes) obj;

Construct a QueryAttributes using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to QueryAttributes.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setApplicationByRef

public void setApplicationByRef(Object rhs1)
                         throws IOException,
                                AutomationException

Provides the window with a reference to the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setApplicationByRef in interface IQueryAttributes

Parameters:

rhs1 - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

public void doModal(int parentHWnd)
             throws IOException,
                    AutomationException

Shows attribute query window in a modal state.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

doModal in interface IQueryAttributes

Parameters:

parentHWnd - The parentHWnd (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCombinationMethod

public void setCombinationMethod(int pMethod)
                          throws IOException,
                                 AutomationException

CombinationMethod on form.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCombinationMethod in interface IQueryAttributes

Parameters:

pMethod - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCombinationMethod

public int getCombinationMethod()
                         throws IOException,
                                AutomationException

CombinationMethod on form.

Remarks

The combination method defines how the selection performed will combine with an existing selection. It is the programmatic equivalent of the pulldown menus found in the selection dialogs in ArcMap.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCombinationMethod in interface IQueryAttributes

Returns:

A com.esri.arcgis.carto.esriSelectionResultEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws IOException,
                       AutomationException

Layer selected by the user.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getLayer in interface IQueryAttributes

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerByRef

public void setLayerByRef(ILayer ppLayer)
                   throws IOException,
                          AutomationException

Layer selected by the user.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setLayerByRef in interface IQueryAttributes

Parameters:

ppLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectFeaturesInLayerOnOK

public void setSelectFeaturesInLayerOnOK(boolean rhs1)
                                  throws IOException,
                                         AutomationException

When the user presses OK, select features. If there is an error, don't return. Default: FALSE.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSelectFeaturesInLayerOnOK in interface IQueryAttributes

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpression

public void setExpression(String rhs1)
                   throws IOException,
                          AutomationException

Default expression.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setExpression in interface IQueryAttributes

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws IOException,
                                   AutomationException

Provide a QueryFilter after form has been executed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getQueryFilter in interface IQueryAttributes

Returns:

A reference to a com.esri.arcgis.geodatabase.IQueryFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show(int parentHWnd)
          throws IOException,
                 AutomationException

Shows attribute query window in a modeless state.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

show in interface IModelessQueryAttributes

Parameters:

parentHWnd - The parentHWnd (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Refreshes the attribute query window when it's in a modeless state.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IModelessQueryAttributes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onAddField

public void onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
                throws IOException,
                       AutomationException

This event is fired when a new field is added to the object class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

onAddField in interface IObjectClassSchemaEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDeleteField

public void onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
                   throws IOException,
                          AutomationException

This event is fired when a field is deleted from the object class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

onDeleteField in interface IObjectClassSchemaEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onBehaviorChanged

public void onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
                       throws IOException,
                              AutomationException

This event is fired when the behavior class for the object class changes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

onBehaviorChanged in interface IObjectClassSchemaEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.