|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.display.MultiLayerFillSymbol
public class MultiLayerFillSymbol
A fill symbol that contains one or more layers.
The MultiLayerFillSymbol is used for creating fill symbols consisting of multiple layers.
Constructor Summary | |
---|---|
MultiLayerFillSymbol()
Constructs a MultiLayerFillSymbol using ArcGIS Engine. |
|
MultiLayerFillSymbol(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. MultiLayerFillSymbol theMultiLayerFillSymbol = (MultiLayerFillSymbol) obj; |
Method Summary | |
---|---|
void |
addLayer(IFillSymbol fillLayer)
Add fill symbol layer. |
boolean |
applies(Object pUnk)
Indicates if the receiver can apply the given object at any given time. |
Object |
apply(Object newObject)
Applies the given property to the receiver and returns the old object. |
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
boolean |
canApply(Object pUnk)
Indicates if the receiver can apply the given object at that particular moment. |
void |
clearLayers()
Remove all symbol layers. |
void |
deleteLayer(IFillSymbol fillLayer)
Delete fill symbol layer. |
void |
draw(IGeometry geometry)
Draws the specified shape. |
void |
drawLayer(int index,
IGeometry geometry)
Draw a symbol layer. |
boolean |
equals(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
IColor |
getColor()
Fill color. |
Object |
getCurrent(Object pUnk)
The object currently being used. |
IFillSymbol |
getLayer(int index)
Fill symbol per layer position. |
int |
getLayerCount()
Symbol layer count. |
String |
getLayerTags(int layerIndex)
Tags for the layer at the specified index. |
int |
getMapLevel()
Current map level for drawing multi-level symbols. |
ILineSymbol |
getOutline()
Line symbol of fill outline. |
int |
getROP2()
Raster operation code for pixel drawing. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
hashCode()
the hashcode for this object |
void |
isDirty()
isDirty |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isLayerColorLock(int layerIndex)
Indicates if a color lock is present for the layer at the specified index. |
boolean |
isLayerVisible(int layerIndex)
Indicates if the layer at the specified index is visible. |
void |
load(IStream pstm)
load |
void |
moveLayer(IFillSymbol fillLayer,
int toIndex)
Change symbol layer position index. |
void |
queryBoundary(int hDC,
ITransformation displayTransform,
IGeometry geometry,
IPolygon boundary)
Fills an existing polygon with the boundary of the specified symbol. |
void |
readExternal(ObjectInput in)
|
void |
resetDC()
Restores DC to original state. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setAllColorLocked(boolean allLocked)
Indicates if the color is locked for all layers. |
void |
setAllVisible(boolean allVisible)
Indicates if all the layers are visible or invisible. |
void |
setColor(IColor color)
Fill color. |
void |
setLayerColorLock(int layerIndex,
boolean colorLock)
Indicates if a color lock is present for the layer at the specified index. |
void |
setLayerTags(int layerIndex,
String tags)
Tags for the layer at the specified index. |
void |
setLayerVisible(int layerIndex,
boolean visible)
Indicates if the layer at the specified index is visible. |
void |
setMapLevel(int mapLevel)
Current map level for drawing multi-level symbols. |
void |
setOutline(ILineSymbol outlineSym)
Line symbol of fill outline. |
void |
setROP2(int drawMode)
Raster operation code for pixel drawing. |
void |
setupDC(int hDC,
ITransformation transformation)
Prepares the DC for drawing the symbol. |
void |
writeExternal(ObjectOutput out)
|
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 MultiLayerFillSymbol() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic MultiLayerFillSymbol(Object obj) throws IOException
MultiLayerFillSymbol theMultiLayerFillSymbol = (MultiLayerFillSymbol) obj;
obj
to MultiLayerFillSymbol
.
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 int getLayerCount() throws IOException, AutomationException
LayerCount returns the total number of layers currently contained in the IMultiLayerFillSymbol.
getLayerCount
in interface IMultiLayerFillSymbol
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFillSymbol getLayer(int index) throws IOException, AutomationException
getLayer
in interface IMultiLayerFillSymbol
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addLayer(IFillSymbol fillLayer) throws IOException, AutomationException
AddLayer adds a single layer to the IMultiLayerFillSymbol. The layer can be of any type supported by the IFillSymbol interface except types implementing IMultiLayerFillSymbol. In this case an E_INVALIDARG HRESULT will be thrown. Therefore, a MultiLayerFillSymbol cannot be imbeded within another MultiLayerFillSymbol.
addLayer
in interface IMultiLayerFillSymbol
fillLayer
- A reference to a com.esri.arcgis.display.IFillSymbol (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteLayer(IFillSymbol fillLayer) throws IOException, AutomationException
DeleteLayer deletes the layer at the given index.
deleteLayer
in interface IMultiLayerFillSymbol
fillLayer
- A reference to a com.esri.arcgis.display.IFillSymbol (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void moveLayer(IFillSymbol fillLayer, int toIndex) throws IOException, AutomationException
MoveLayer moves the spcefied IFillSymbol to the specified index within the IMultiLayerFillSymbol.
moveLayer
in interface IMultiLayerFillSymbol
fillLayer
- A reference to a com.esri.arcgis.display.IFillSymbol (in)toIndex
- The toIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clearLayers() throws IOException, AutomationException
ClearLayers removes all the layers contained within the IMultiLayerFillSymbol.
clearLayers
in interface IMultiLayerFillSymbol
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void drawLayer(int index, IGeometry geometry) throws IOException, AutomationException
DrawLayer draws the IFillSymbol stored at the specified index within the IMultiLayerFillSymbol.
drawLayer
in interface IMultiLayerFillSymbol
index
- The index (in)geometry
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IColor getColor() throws IOException, AutomationException
getColor
in interface IFillSymbol
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setColor(IColor color) throws IOException, AutomationException
Color is the color for a FillSymbol object. Any IColor object can be used.
setColor
in interface IFillSymbol
color
- A reference to a com.esri.arcgis.display.IColor (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILineSymbol getOutline() throws IOException, AutomationException
Outline is the border for a FillSymbol object. Any ILineSymbol object can be used.
getOutline
in interface IFillSymbol
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOutline(ILineSymbol outlineSym) throws IOException, AutomationException
Outline is the border for a FillSymbol object. Any ILineSymbol object can be used.
setOutline
in interface IFillSymbol
outlineSym
- A reference to a com.esri.arcgis.display.ILineSymbol (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMapLevel() throws IOException, AutomationException
getMapLevel
in interface IMapLevel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMapLevel(int mapLevel) throws IOException, AutomationException
setMapLevel
in interface IMapLevel
mapLevel
- The mapLevel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setupDC(int hDC, ITransformation transformation) throws IOException, AutomationException
setupDC
in interface ISymbol
hDC
- The hDC (A COM typedef) (in)transformation
- A reference to a com.esri.arcgis.geometry.ITransformation (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void resetDC() throws IOException, AutomationException
resetDC
in interface ISymbol
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void draw(IGeometry geometry) throws IOException, AutomationException
draw
in interface ISymbol
geometry
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryBoundary(int hDC, ITransformation displayTransform, IGeometry geometry, IPolygon boundary) throws IOException, AutomationException
Valid input Geometries are as follows:
For MarkerSymbols, the Geometry must be an IPoint.
For Fill Symbols, the Geometry can be either an IPolygon or an IEnvelope.
For Line Symbols, the Geometry must be an IPolyline.
queryBoundary
in interface ISymbol
hDC
- The hDC (A COM typedef) (in)displayTransform
- A reference to a com.esri.arcgis.geometry.ITransformation (in)geometry
- A reference to a com.esri.arcgis.geometry.IGeometry (in)boundary
- A reference to a com.esri.arcgis.geometry.IPolygon (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getROP2() throws IOException, AutomationException
getROP2
in interface ISymbol
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setROP2(int drawMode) throws IOException, AutomationException
setROP2
in interface ISymbol
drawMode
- A com.esri.arcgis.display.esriRasterOpCode constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isLayerVisible(int layerIndex) throws IOException, AutomationException
isLayerVisible
in interface ILayerVisible
layerIndex
- The layerIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerVisible(int layerIndex, boolean visible) throws IOException, AutomationException
setLayerVisible
in interface ILayerVisible
layerIndex
- The layerIndex (in)visible
- The visible (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAllVisible(boolean allVisible) throws IOException, AutomationException
SetAllVisible indicates whether all layers of a MultiLayerFillSymbol, MultiLayerMarkerSymbol or MultiLayerLineSymbol will be displayed when the symbol is rendered.
setAllVisible
in interface ILayerVisible
allVisible
- The allVisible (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isLayerColorLock(int layerIndex) throws IOException, AutomationException
isLayerColorLock
in interface ILayerColorLock
layerIndex
- The layerIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerColorLock(int layerIndex, boolean colorLock) throws IOException, AutomationException
setLayerColorLock
in interface ILayerColorLock
layerIndex
- The layerIndex (in)colorLock
- The colorLock (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAllColorLocked(boolean allLocked) throws IOException, AutomationException
SetAllColorLocked indicates whether all layers of a MultiLayerFillSymbol, MultiLayerMarkerSymbol or MultiLayerLineSymbol will be locked to their current color.
setAllColorLocked
in interface ILayerColorLock
allLocked
- The allLocked (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean applies(Object pUnk) throws IOException, AutomationException
Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.
CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.
applies
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canApply(Object pUnk) throws IOException, AutomationException
CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.
CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.
canApply
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getCurrent(Object pUnk) throws IOException, AutomationException
getCurrent
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object apply(Object newObject) throws IOException, AutomationException
Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.
Use the Applies and CanApply methods to determine if an Apply can be used on an object.
apply
in interface IPropertySupport
newObject
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws IOException, AutomationException
esri_clone
in interface IClone
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws IOException, AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws IOException, AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getLayerTags(int layerIndex) throws IOException, AutomationException
getLayerTags
in interface ILayerTags
layerIndex
- The layerIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerTags(int layerIndex, String tags) throws IOException, AutomationException
setLayerTags
in interface ILayerTags
layerIndex
- The layerIndex (in)tags
- The tags (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |