|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.GPServerTrackCancel
public class GPServerTrackCancel
GP Server Track Cancel Class.
Constructor Summary | |
---|---|
GPServerTrackCancel()
Constructs a GPServerTrackCancel using ArcGIS Engine. |
|
GPServerTrackCancel(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GPServerTrackCancel theGPServerTrackCancel = (GPServerTrackCancel) obj; |
Method Summary | |
---|---|
void |
cancel()
Cancels the associated operation. |
boolean |
equals(Object o)
Compare this object with another |
boolean |
esri_continue()
Called frequently while associated operation is progressing. |
int |
getCheckTime()
The interval at which the operation will be interrupted to advance progressors and process messages. |
static String |
getClsid()
getClsid. |
IJobMessages |
getJobMessages()
The job messages. |
int |
getMaxRange()
The maximum range of the progression. |
String |
getMessage()
The message displayed by the progressor. |
int |
getMessageLevel()
The message level. |
int |
getMinRange()
The minimum range of the progression. |
int |
getPosition()
The current position of the progression. |
IProgressor |
getProgressor()
The progressor used to show progress during lengthy operations. |
int |
getStepValue()
The step increment of the progression. |
int |
hashCode()
the hashcode for this object |
void |
hide()
Hides the progressor. |
void |
init(Object pJobTracker)
Initialize the track cancel. |
boolean |
isCancelOnClick()
Indicates whether mouse clicks should cancel the operation. |
boolean |
isCancelOnKeyPress()
Indicates whether the escape key and spacebar should cancel the operation. |
boolean |
isProcessMessages()
An obsolete method. |
boolean |
isTimerFired()
An obsolete method. |
void |
messageAdded(IGPMessage message)
Fired when a geoprocessing message is added. |
int |
offsetPosition(int offsetValue)
Offsets the position of the progression. |
void |
reset()
Resets the manager after the associated operation is finished. |
void |
setCancelOnClick(boolean pCancelOnClick)
Indicates whether mouse clicks should cancel the operation. |
void |
setCancelOnKeyPress(boolean pCancelOnKeyPress)
Indicates whether the escape key and spacebar should cancel the operation. |
void |
setCheckTime(int milliseconds)
The interval at which the operation will be interrupted to advance progressors and process messages. |
void |
setMaxRange(int maxRange)
The maximum range of the progression. |
void |
setMessage(String message)
The message displayed by the progressor. |
void |
setMessageLevel(int messageLevel)
The message level. |
void |
setMinRange(int minRange)
The minimum range of the progression. |
void |
setPosition(int position)
The current position of the progression. |
void |
setProcessMessages(boolean processMessages)
An obsolete method. |
void |
setProgressor(IProgressor progressor)
The progressor used to show progress during lengthy operations. |
void |
setStepValue(int step)
The step increment of the progression. |
void |
show()
Shows the progressor. |
void |
startTimer(int hWnd,
int milliseconds)
An obsolete method. |
void |
step()
Animates or steps the progressor. |
void |
stopTimer()
An obsolete method. |
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 |
---|
public GPServerTrackCancel() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic GPServerTrackCancel(Object obj) throws IOException
GPServerTrackCancel theGPServerTrackCancel = (GPServerTrackCancel) obj;
obj
to GPServerTrackCancel
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void setCheckTime(int milliseconds) throws IOException, AutomationException
setCheckTime
in interface ITrackCancel
milliseconds
- The milliseconds (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCheckTime() throws IOException, AutomationException
The CheckTime property indicates the frequency the CancelTracker will process any pending Windows (mouse and keyboard) messages. By default the CheckTime is 1000 milliseconds.
getCheckTime
in interface ITrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setProgressor(IProgressor progressor) throws IOException, AutomationException
setProgressor
in interface ITrackCancel
progressor
- A reference to a com.esri.arcgis.system.IProgressor (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IProgressor getProgressor() throws IOException, AutomationException
Use the Progressor property to bind the CancelTracker with a progress object (for example, a progress bar, a progress dialog or a progress animation) that displays the progress of the lengthy operation. Once the Progressor has been set it will be updated automatically as the operation is executed.
If the progressor is a step progressor, the MaxRange should be set to equal the number of iterations that the operation will progress through; this number should also match the number of times Continue will be called in the operation’s innermost loop.
getProgressor
in interface ITrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void cancel() throws IOException, AutomationException
By default a cancel will occur under the following circumstances:
Whether a cancel occurs will depend on when the key or button was pressed and the CheckTime property. For example, if a map redraw was cancelled by a key press then it is possible that some phases of the redraw will complete before the key press is handled.
cancel
in interface ITrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void reset() throws IOException, AutomationException
The Reset method should be called just before a process that may be cancelled, such as a lengthy operation, begins. The Reset method sets the state of the CancelTracker to uncancelled and returns the internal counter, which is used to update the Progressor to zero.
reset
in interface ITrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean esri_continue() throws IOException, AutomationException
esri_continue
in interface ITrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setProcessMessages(boolean processMessages) throws IOException, AutomationException
setProcessMessages
in interface ITrackCancel
processMessages
- The processMessages (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isProcessMessages() throws IOException, AutomationException
Do not use this method as it is obsolete.
isProcessMessages
in interface ITrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void startTimer(int hWnd, int milliseconds) throws IOException, AutomationException
Do not use this method as it is obsolete.
startTimer
in interface ITrackCancel
hWnd
- The hWnd (in)milliseconds
- The milliseconds (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isTimerFired() throws IOException, AutomationException
Do not use this method as it is obsolete.
isTimerFired
in interface ITrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void stopTimer() throws IOException, AutomationException
Do not use this method as it is obsolete.
stopTimer
in interface ITrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCancelOnClick() throws IOException, AutomationException
Indicates whether the user can use the left and right mouse buttons to cancel the operation.
isCancelOnClick
in interface ITrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCancelOnClick(boolean pCancelOnClick) throws IOException, AutomationException
setCancelOnClick
in interface ITrackCancel
pCancelOnClick
- The pCancelOnClick (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCancelOnKeyPress() throws IOException, AutomationException
Indicates whether the user can use the space bar to cancel the operation.
isCancelOnKeyPress
in interface ITrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCancelOnKeyPress(boolean pCancelOnKeyPress) throws IOException, AutomationException
setCancelOnKeyPress
in interface ITrackCancel
pCancelOnKeyPress
- The pCancelOnKeyPress (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMessage(String message) throws IOException, AutomationException
setMessage
in interface IProgressor
message
- The message (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getMessage() throws IOException, AutomationException
This is a generic Message property for progressors (for example a progress bar).
getMessage
in interface IProgressor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void show() throws IOException, AutomationException
This is a generic Show method for progressors (for example a progress bar).
show
in interface IProgressor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void step() throws IOException, AutomationException
This is a generic Step method for progressors (for example a progress bar).
step
in interface IProgressor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void hide() throws IOException, AutomationException
This is a generic Hide method for progressors (for example a progress bar).
hide
in interface IProgressor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMinRange(int minRange) throws IOException, AutomationException
setMinRange
in interface IStepProgressor
minRange
- The minRange (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMinRange() throws IOException, AutomationException
The minimum value of the step progressor.
getMinRange
in interface IStepProgressor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaxRange(int maxRange) throws IOException, AutomationException
setMaxRange
in interface IStepProgressor
maxRange
- The maxRange (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMaxRange() throws IOException, AutomationException
The maximum value of the step progressor.
getMaxRange
in interface IStepProgressor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setStepValue(int step) throws IOException, AutomationException
setStepValue
in interface IStepProgressor
step
- The step (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getStepValue() throws IOException, AutomationException
The increment value taken by the progression with each step.
getStepValue
in interface IStepProgressor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPosition(int position) throws IOException, AutomationException
The current position of the progression between the MinRange and MaxRange values.
setPosition
in interface IStepProgressor
position
- The position (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getPosition() throws IOException, AutomationException
The current position of the progression between the MinRange and MaxRange values.
getPosition
in interface IStepProgressor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int offsetPosition(int offsetValue) throws IOException, AutomationException
Offsets the current Position by the specified value.
offsetPosition
in interface IStepProgressor
offsetValue
- The offsetValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void messageAdded(IGPMessage message) throws IOException, AutomationException
messageAdded
in interface IGPMessagesCallback
message
- A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void init(Object pJobTracker) throws IOException, AutomationException
init
in interface IGPServerTrackCancel
pJobTracker
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IJobMessages getJobMessages() throws IOException, AutomationException
getJobMessages
in interface IGPServerTrackCancel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMessageLevel() throws IOException, AutomationException
getMessageLevel
in interface IGPServerTrackCancel2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMessageLevel(int messageLevel) throws IOException, AutomationException
setMessageLevel
in interface IGPServerTrackCancel2
messageLevel
- A com.esri.arcgis.system.esriJobMessageType constant (in)
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 |