com.esri.arcgis.controls
Interface IEngineInkEnvironment

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

EngineInkEnvironment, IEngineInkEnvironmentProxy

public interface IEngineInkEnvironment
extends java.io.Serializable

COM Interface 'IEngineInkEnvironment'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the EngineInkEnvironment singleton.' 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	IID Deprecated. Internal use only
static int	IID61fe0c4b_89bb_4f7e_b284_f266c708d53f
static int	xxDummy Deprecated. Internal use only

Method Summary

void	clear() Deletes any active ink from the screen.
int	getInkCollectionMode() Indicates if the extension is collecting ink.
java.lang.Object	getInkCollector() The internal ink collecting object.
java.lang.Object	getInkGeometry() The current Ink sketch as a geometry.
float	getToolCommitDelay() The auto commit delay interval in seconds.
int	getToolCommitType() The ink tool commit type.
boolean	isAlwaysShowAlternates() Indicates if the alternates dialog will always be shown when performing text recognition.
boolean	isAutoRecognizeInkGraphics() Indicates whether to attempt to recognize newly created InkGraphics as text.
boolean	isGeneralizeInk() Indicates whether the Ink should be generalized.
boolean	isMapNavigationGesturesEnabled() Indicates whether the map navigation gestures should be enabled.
boolean	isOnlyEraseActiveInkSketch() Indicates if only the active ink sketch may be erased.
boolean	isPressureSensitiveStylus() Indicates if the ink stylus is pressure-sensitive.
boolean	isProjectInkGraphicGeometry() Indicates whether to project an InkGraphic's Geometry.
boolean	isScratchoutEnabled() Indicates whether the scratch-out gesture should be enabled.
void	setAlwaysShowAlternates(boolean showAlternates) Indicates if the alternates dialog will always be shown when performing text recognition.
void	setAutoRecognizeInkGraphics(boolean autoRecognize) Indicates whether to attempt to recognize newly created InkGraphics as text.
void	setGeneralizeInk(boolean generalizeInk) Indicates whether the Ink should be generalized.
void	setMapNavigationGesturesEnabled(boolean pEnabled) Indicates whether the map navigation gestures should be enabled.
void	setOnlyEraseActiveInkSketch(boolean onlyActive) Indicates if only the active ink sketch may be erased.
void	setPressureSensitiveStylus(boolean usePressureSensitive) Indicates if the ink stylus is pressure-sensitive.
void	setProjectInkGraphicGeometry(boolean projectInkGraphics) Indicates whether to project an InkGraphic's Geometry.
void	setScratchoutEnabled(boolean pScratchout) Indicates whether the scratch-out gesture should be enabled.
void	setToolCommitDelay(float pDelay) The auto commit delay interval in seconds.
void	setToolCommitType(int pToolCommitType) The ink tool commit type.
void	start(boolean bGesturesOnly) Starts obtaining ink from the stylus.
void	stop(boolean bKeepInk) Stops obtaining ink from the stylus.

Field Detail

IID61fe0c4b_89bb_4f7e_b284_f266c708d53f

static final int IID61fe0c4b_89bb_4f7e_b284_f266c708d53f

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

Method Detail

start

void start(boolean bGesturesOnly)
           throws java.io.IOException,
                  AutomationException

Starts obtaining ink from the stylus.

Parameters:

bGesturesOnly - The bGesturesOnly (in, optional, pass false if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stop

void stop(boolean bKeepInk)
          throws java.io.IOException,
                 AutomationException

Stops obtaining ink from the stylus.

Parameters:

bKeepInk - The bKeepInk (in, optional, pass false if not required)

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

Deletes any active ink from the screen.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInkCollectionMode

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

Indicates if the extension is collecting ink.

Returns:

A com.esri.arcgis.controls.esriEngineInkCollectionMode constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInkCollector

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

The internal ink collecting object.

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setToolCommitType

void setToolCommitType(int pToolCommitType)
                       throws java.io.IOException,
                              AutomationException

The ink tool commit type.

Parameters:

pToolCommitType - A com.esri.arcgis.controls.esriEngineInkToolCommitType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolCommitType

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

The ink tool commit type.

Returns:

A com.esri.arcgis.controls.esriEngineInkToolCommitType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setToolCommitDelay

void setToolCommitDelay(float pDelay)
                        throws java.io.IOException,
                               AutomationException

The auto commit delay interval in seconds.

Parameters:

pDelay - The pDelay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolCommitDelay

float getToolCommitDelay()
                         throws java.io.IOException,
                                AutomationException

The auto commit delay interval in seconds.

Returns:

The pDelay

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPressureSensitiveStylus

void setPressureSensitiveStylus(boolean usePressureSensitive)
                                throws java.io.IOException,
                                       AutomationException

Indicates if the ink stylus is pressure-sensitive.

Parameters:

usePressureSensitive - The usePressureSensitive (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPressureSensitiveStylus

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

Indicates if the ink stylus is pressure-sensitive.

Returns:

The usePressureSensitive

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeneralizeInk

void setGeneralizeInk(boolean generalizeInk)
                      throws java.io.IOException,
                             AutomationException

Indicates whether the Ink should be generalized.

Parameters:

generalizeInk - The generalizeInk (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGeneralizeInk

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

Indicates whether the Ink should be generalized.

Returns:

The generalizeInk

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInkGeometry

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

The current Ink sketch as a geometry.

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoRecognizeInkGraphics

void setAutoRecognizeInkGraphics(boolean autoRecognize)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether to attempt to recognize newly created InkGraphics as text.

Parameters:

autoRecognize - The autoRecognize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoRecognizeInkGraphics

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

Indicates whether to attempt to recognize newly created InkGraphics as text.

Returns:

The autoRecognize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScratchoutEnabled

void setScratchoutEnabled(boolean pScratchout)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether the scratch-out gesture should be enabled.

Parameters:

pScratchout - The pScratchout (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isScratchoutEnabled

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

Indicates whether the scratch-out gesture should be enabled.

Returns:

The pScratchout

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProjectInkGraphicGeometry

void setProjectInkGraphicGeometry(boolean projectInkGraphics)
                                  throws java.io.IOException,
                                         AutomationException

Indicates whether to project an InkGraphic's Geometry.

Parameters:

projectInkGraphics - The projectInkGraphics (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isProjectInkGraphicGeometry

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

Indicates whether to project an InkGraphic's Geometry.

Returns:

The projectInkGraphics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAlwaysShowAlternates

void setAlwaysShowAlternates(boolean showAlternates)
                             throws java.io.IOException,
                                    AutomationException

Indicates if the alternates dialog will always be shown when performing text recognition.

Parameters:

showAlternates - The showAlternates (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAlwaysShowAlternates

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

Indicates if the alternates dialog will always be shown when performing text recognition.

Returns:

The showAlternates

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOnlyEraseActiveInkSketch

void setOnlyEraseActiveInkSketch(boolean onlyActive)
                                 throws java.io.IOException,
                                        AutomationException

Indicates if only the active ink sketch may be erased.

Parameters:

onlyActive - The onlyActive (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOnlyEraseActiveInkSketch

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

Indicates if only the active ink sketch may be erased.

Returns:

The onlyActive

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapNavigationGesturesEnabled

void setMapNavigationGesturesEnabled(boolean pEnabled)
                                     throws java.io.IOException,
                                            AutomationException

Indicates whether the map navigation gestures should be enabled.

Parameters:

pEnabled - The pEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isMapNavigationGesturesEnabled

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

Indicates whether the map navigation gestures should be enabled.

Returns:

The pEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.