Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.display
Interface IDisplay

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IAppDisplay, IScreenDisplay, IScreenDisplay2, IScreenDisplay3
All Known Implementing Classes:
AppDisplay, GlobeDisplay, IAppDisplayProxy, IDisplayProxy, IScreenDisplay2Proxy, IScreenDisplay3Proxy, IScreenDisplayProxy, SceneGraph, ScreenDisplay, SimpleDisplay
public interface IDisplay
extends java.io.Serializable

COM Interface 'IDisplay'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description: 'Provides access to members that control the Display.' 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 IIDe6bdb002_4d35_11d0_98be_00805f7ced21
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void drawMultipoint(IGeometry multipoint)
          Draws specified multipoint on the display.
 void drawPoint(IGeometry point)
          Draws specified point on the display.
 void drawPolygon(IGeometry polygon)
          Draws specified polygon on the display.
 void drawPolyline(IGeometry polyline)
          Draws specified line on the display.
 void drawRectangle(IEnvelope rectangle)
          Draws specified rectangle on the display.
 void drawText(IGeometry shape, java.lang.String text)
          Draws specified text on the display.
 void finishDrawing()
          Completes drawing.
 IEnvelope getClipEnvelope()
          The bounds of the invalid region.
 ISet getClipEnvelopes()
          The invalid region as a set of envelopes.
 IGeometry getClipGeometry()
          User-specified clip shape.
 IDisplayTransformation getDisplayTransformation()
          The transformation used by the display.
 IDisplayFilter getFilter()
          Display filter.
 int getHDC()
          The device context that the display is currently drawing to.
 int getHPalette()
          Palette.
 IIlluminationProps getIlluminationProps()
          Illumination properties used by the display.
 boolean isSuppressEvents()
          Indicates if display object suppresses events.
 void progress(int vertexCount)
          Call frequently during drawing process.
 void setClipGeometry(IGeometry geometry)
          User-specified clip shape.
 void setDisplayTransformation(IDisplayTransformation displayTransformation)
          The transformation used by the display.
 void setFilterByRef(IDisplayFilter filter)
          Display filter.
 void setHPalette(int hPalette)
          Palette.
 void setIlluminationProps(IIlluminationProps illuminationProps)
          Illumination properties used by the display.
 void setSuppressEvents(boolean suppressEvents)
          Indicates if display object suppresses events.
 void setSymbol(ISymbol sym)
          Sets the symbol used for drawing.
 void startDrawing(int hDC, short cacheID)
          Prepare the display for drawing.
 

Field Detail

IIDe6bdb002_4d35_11d0_98be_00805f7ced21

static final int IIDe6bdb002_4d35_11d0_98be_00805f7ced21
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

getDisplayTransformation

IDisplayTransformation getDisplayTransformation()
                                                throws java.io.IOException,
                                                       AutomationException
The transformation used by the display.

Returns:
A reference to a com.esri.arcgis.display.IDisplayTransformation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayTransformation

void setDisplayTransformation(IDisplayTransformation displayTransformation)
                              throws java.io.IOException,
                                     AutomationException
The transformation used by the display.

Parameters:
displayTransformation - A reference to a com.esri.arcgis.display.IDisplayTransformation (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClipEnvelope

IEnvelope getClipEnvelope()
                          throws java.io.IOException,
                                 AutomationException
The bounds of the invalid region. Use after StartDrawing and before FinishDrawing.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClipEnvelopes

ISet getClipEnvelopes()
                      throws java.io.IOException,
                             AutomationException
The invalid region as a set of envelopes. Use after StartDrawing and before FinishDrawing.

Returns:
A reference to a com.esri.arcgis.system.ISet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClipGeometry

IGeometry getClipGeometry()
                          throws java.io.IOException,
                                 AutomationException
User-specified clip shape. This shape is merged with the invalid region to arrive at the actual clip region. Must be specified before StartDrawing.

Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClipGeometry

void setClipGeometry(IGeometry geometry)
                     throws java.io.IOException,
                            AutomationException
User-specified clip shape. This shape is merged with the invalid region to arrive at the actual clip region. Must be specified before StartDrawing.

Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSuppressEvents

boolean isSuppressEvents()
                         throws java.io.IOException,
                                AutomationException
Indicates if display object suppresses events.

Returns:
The suppressEvents
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSuppressEvents

void setSuppressEvents(boolean suppressEvents)
                       throws java.io.IOException,
                              AutomationException
Indicates if display object suppresses events.

Parameters:
suppressEvents - The suppressEvents (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilter

IDisplayFilter getFilter()
                         throws java.io.IOException,
                                AutomationException
Display filter. Must call while in a StartDrawing-FinishDrawing sequence. Set Filter to 0 to resume normal drawing.

Returns:
A reference to a com.esri.arcgis.display.IDisplayFilter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFilterByRef

void setFilterByRef(IDisplayFilter filter)
                    throws java.io.IOException,
                           AutomationException
Display filter. Must call while in a StartDrawing-FinishDrawing sequence. Set Filter to 0 to resume normal drawing.

Parameters:
filter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHPalette

int getHPalette()
                throws java.io.IOException,
                       AutomationException
Palette.

Returns:
The hPalette (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHPalette

void setHPalette(int hPalette)
                 throws java.io.IOException,
                        AutomationException
Palette.

Parameters:
hPalette - The hPalette (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startDrawing

void startDrawing(int hDC,
                  short cacheID)
                  throws java.io.IOException,
                         AutomationException
Prepare the display for drawing. Specify the device context and the cache to draw to (normally esriNoScreenCache). The ScreenDisplay coclass will automatically create a window device context if you specify hdc = 0.

Parameters:
hDC - The hDC (A COM typedef) (in)
cacheID - The cacheID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHDC

int getHDC()
           throws java.io.IOException,
                  AutomationException
The device context that the display is currently drawing to. Only valid between calls to StartDrawing and FinishDrawing.

Returns:
The hDC (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

finishDrawing

void finishDrawing()
                   throws java.io.IOException,
                          AutomationException
Completes drawing.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

progress

void progress(int vertexCount)
              throws java.io.IOException,
                     AutomationException
Call frequently during drawing process.

Parameters:
vertexCount - The vertexCount (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawPoint

void drawPoint(IGeometry point)
               throws java.io.IOException,
                      AutomationException
Draws specified point on the display.

Parameters:
point - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawMultipoint

void drawMultipoint(IGeometry multipoint)
                    throws java.io.IOException,
                           AutomationException
Draws specified multipoint on the display.

Parameters:
multipoint - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawRectangle

void drawRectangle(IEnvelope rectangle)
                   throws java.io.IOException,
                          AutomationException
Draws specified rectangle on the display.

Parameters:
rectangle - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawPolyline

void drawPolyline(IGeometry polyline)
                  throws java.io.IOException,
                         AutomationException
Draws specified line on the display.

Parameters:
polyline - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawPolygon

void drawPolygon(IGeometry polygon)
                 throws java.io.IOException,
                        AutomationException
Draws specified polygon on the display.

Parameters:
polygon - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawText

void drawText(IGeometry shape,
              java.lang.String text)
              throws java.io.IOException,
                     AutomationException
Draws specified text on the display.

Parameters:
shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
text - The text (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbol

void setSymbol(ISymbol sym)
               throws java.io.IOException,
                      AutomationException
Sets the symbol used for drawing. Four different symbols can be specified simultaneously: Marker, Line, Fill, Text.

Parameters:
sym - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIlluminationProps

IIlluminationProps getIlluminationProps()
                                        throws java.io.IOException,
                                               AutomationException
Illumination properties used by the display.

Returns:
A reference to a com.esri.arcgis.display.IIlluminationProps
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIlluminationProps

void setIlluminationProps(IIlluminationProps illuminationProps)
                          throws java.io.IOException,
                                 AutomationException
Illumination properties used by the display.

Parameters:
illuminationProps - A reference to a com.esri.arcgis.display.IIlluminationProps (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD