com.esri.arcgis.display
Class BasicLineSymbol

java.lang.Object
  extended by com.esri.arcgis.display.BasicLineSymbol
All Implemented Interfaces:
IBasicLineSymbol, IBasicSymbol, IDrawingOutline, IGeometricEffect, IGeometricEffects, IMapLevel, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class BasicLineSymbol
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IBasicSymbol, IBasicLineSymbol, IMapLevel, IGeometricEffects, IGeometricEffect, IDrawingOutline, IPersist, IPersistStream, ISupportErrorInfo, IDocumentVersionSupportGEN, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'BasicLineSymbol'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'Basic line symbol object.' 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 =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.display.IBasicSymbol
IID, IID0e4428d1_2e96_4bdd_b253_06b4c9a75c7a, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IBasicLineSymbol
IID, IID6e353af0_24ec_4000_a9fe_8e58b16e12cd, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IMapLevel
IID, IIDcef72580_c1d9_11d2_9888_0080c7e04196, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IGeometricEffects
IID, IID6f68089c_1026_4ba3_8930_a52d62eec539, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IGeometricEffect
IID, IIDa5a4ca1c_1164_4dc4_ae82_5611a8f807e5, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDrawingOutline
IID, IID5b50cf13_4f70_4bed_b1b7_55f3aa8d26f8, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport
IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy
 
Constructor Summary
BasicLineSymbol()
          Constructs a BasicLineSymbol using ArcGIS Engine.
BasicLineSymbol(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BasicLineSymbol theBasicLineSymbol = (BasicLineSymbol) obj;
 
Method Summary
 void add(IGeometricEffect geomEffect)
          Adds a new geometric effect.
 java.lang.Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void draw(IOutputContext context, IGeometry geometry, IEnvelope envelope)
          Draws the basic symbol.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IGeometry getAllOutlineParts(IGeometry geometry, int type, int option, double buffer, IEnvelope clipEnvelope)
          Constructs the entire drawing outline of a drawing rule.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 int getCount()
          Number of geometric effects.
 IGeometricEffect getElement(int index)
          The geometric effect at the specified position.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getMapLevel()
          Current map level for drawing multi-level symbols.
 java.lang.String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 int getOutputType(int inputType)
          The output type of the geometric effect.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ILineStroke getStroke()
          Line stroke of a basic line symbol.
 int hashCode()
          the hashcode for this object
 boolean hitTest(IGeometry geometry, IPoint point, double tolerance)
          Tests if a point is located on the drawing outline.
 void insert(int index, IGeometricEffect geomEffect)
          Inserts a new geometric effect.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void isDirty()
          isDirty
 boolean isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 void load(IStream pstm)
          load
 IGeometry nextGeometry()
          Accesses the next geometry generated by th effect.
 IGeometry nextOutlinePart()
          Retrieves the next part of the outline.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a BasicLineSymbol.
 void remove(int index)
          Removes a geometric effect.
 void removeAll()
          Removes all geometric effects.
 void reset(IGeometry geometry)
          Resets the collection of generated geometries.
 void reset(IGeometry geometry, int type, int option, double buffer, IEnvelope clipEnvelope)
          Resets the outline part enumeration.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setMapLevel(int mapLevel)
          Current map level for drawing multi-level symbols.
 void setStrokeByRef(ILineStroke stroke)
          Line stroke of a basic line symbol.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

BasicLineSymbol

public BasicLineSymbol()
                throws java.io.IOException,
                       java.net.UnknownHostException
Constructs a BasicLineSymbol using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

BasicLineSymbol

public BasicLineSymbol(java.lang.Object obj)
                throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BasicLineSymbol theBasicLineSymbol = (BasicLineSymbol) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a BasicLineSymbol.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

draw

public void draw(IOutputContext context,
                 IGeometry geometry,
                 IEnvelope envelope)
          throws java.io.IOException,
                 AutomationException
Draws the basic symbol.

Specified by:
draw in interface IBasicSymbol
Parameters:
context - A reference to a com.esri.arcgis.display.IOutputContext (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
envelope - 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.

getStroke

public ILineStroke getStroke()
                      throws java.io.IOException,
                             AutomationException
Line stroke of a basic line symbol.

Specified by:
getStroke in interface IBasicLineSymbol
Returns:
A reference to a com.esri.arcgis.display.ILineStroke
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStrokeByRef

public void setStrokeByRef(ILineStroke stroke)
                    throws java.io.IOException,
                           AutomationException
Line stroke of a basic line symbol.

Specified by:
setStrokeByRef in interface IBasicLineSymbol
Parameters:
stroke - A reference to a com.esri.arcgis.display.ILineStroke (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapLevel

public int getMapLevel()
                throws java.io.IOException,
                       AutomationException
Current map level for drawing multi-level symbols.

Specified by:
getMapLevel in interface IMapLevel
Returns:
The mapLevel
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException
Current map level for drawing multi-level symbols.

Specified by:
setMapLevel in interface IMapLevel
Parameters:
mapLevel - The mapLevel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException
Number of geometric effects.

Specified by:
getCount in interface IGeometricEffects
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElement

public IGeometricEffect getElement(int index)
                            throws java.io.IOException,
                                   AutomationException
The geometric effect at the specified position.

Specified by:
getElement in interface IGeometricEffects
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.IGeometricEffect
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   IGeometricEffect geomEffect)
            throws java.io.IOException,
                   AutomationException
Inserts a new geometric effect.

Specified by:
insert in interface IGeometricEffects
Parameters:
index - The index (in)
geomEffect - A reference to a com.esri.arcgis.display.IGeometricEffect (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IGeometricEffect geomEffect)
         throws java.io.IOException,
                AutomationException
Adds a new geometric effect.

Specified by:
add in interface IGeometricEffects
Parameters:
geomEffect - A reference to a com.esri.arcgis.display.IGeometricEffect (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws java.io.IOException,
                   AutomationException
Removes a geometric effect.

Specified by:
remove in interface IGeometricEffects
Parameters:
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws java.io.IOException,
                      AutomationException
Removes all geometric effects.

Specified by:
removeAll in interface IGeometricEffects
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutputType

public int getOutputType(int inputType)
                  throws java.io.IOException,
                         AutomationException
The output type of the geometric effect.

Specified by:
getOutputType in interface IGeometricEffect
Parameters:
inputType - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset(IGeometry geometry)
           throws java.io.IOException,
                  AutomationException
Resets the collection of generated geometries. Must be called before using NextGeometry.

Specified by:
reset in interface IGeometricEffect
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.

nextGeometry

public IGeometry nextGeometry()
                       throws java.io.IOException,
                              AutomationException
Accesses the next geometry generated by th effect.

Specified by:
nextGeometry in interface IGeometricEffect
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.

hitTest

public boolean hitTest(IGeometry geometry,
                       IPoint point,
                       double tolerance)
                throws java.io.IOException,
                       AutomationException
Tests if a point is located on the drawing outline.

Specified by:
hitTest in interface IDrawingOutline
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
tolerance - The tolerance (in)
Returns:
The hit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAllOutlineParts

public IGeometry getAllOutlineParts(IGeometry geometry,
                                    int type,
                                    int option,
                                    double buffer,
                                    IEnvelope clipEnvelope)
                             throws java.io.IOException,
                                    AutomationException
Constructs the entire drawing outline of a drawing rule.

Specified by:
getAllOutlineParts in interface IDrawingOutline
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
type - A com.esri.arcgis.display.esriOutlineType constant (in)
option - A com.esri.arcgis.display.esriOutlineOption constant (in)
buffer - The buffer (in)
clipEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
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.

reset

public void reset(IGeometry geometry,
                  int type,
                  int option,
                  double buffer,
                  IEnvelope clipEnvelope)
           throws java.io.IOException,
                  AutomationException
Resets the outline part enumeration.

Specified by:
reset in interface IDrawingOutline
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
type - A com.esri.arcgis.display.esriOutlineType constant (in)
option - A com.esri.arcgis.display.esriOutlineOption constant (in)
buffer - The buffer (in)
clipEnvelope - 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.

nextOutlinePart

public IGeometry nextOutlinePart()
                          throws java.io.IOException,
                                 AutomationException
Retrieves the next part of the outline.

Specified by:
nextOutlinePart in interface IDrawingOutline
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.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException
Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:
isSupportedAtVersion in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException
Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:
convertToSupportedObject in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException