|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.trackinganalyst.TemporalLegendGroup
public class TemporalLegendGroup
COM Class 'TemporalLegendGroup'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'
Description 'Contains group of two or more temporal legend classes.' 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 long |
serialVersionUID
|
| Fields inherited from interface com.esri.arcgis.trackinganalyst.ITemporalLegendGroup2 |
|---|
IID, IIDce0e96b2_5bf1_4062_88db_67c515b7879a, xxDummy |
| Fields inherited from interface com.esri.arcgis.trackinganalyst.ITemporalLegendGroup |
|---|
IIDb75d7088_1333_11d5_b7c9_00010265adc5 |
| Fields inherited from interface com.esri.arcgis.carto.ILegendGroup |
|---|
IID, IID167c5e9f_af20_11d1_8817_080009ec732a, 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.IClone |
|---|
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy |
| Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo |
|---|
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy |
| Constructor Summary | |
|---|---|
TemporalLegendGroup()
Constructs a TemporalLegendGroup using ArcGIS Engine. |
|
TemporalLegendGroup(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. TemporalLegendGroup theTemporalLegendGroup = (TemporalLegendGroup) obj; |
|
| Method Summary | |
|---|---|
void |
addClass(ILegendClass legendClass)
Adds a new legend class to the group at the end of list. |
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
void |
clearClasses()
Removes all classes from the group. |
java.lang.Object |
convertToSupportedObject(int docVersion)
Convert the object to another object that is supported. |
boolean |
equals(java.lang.Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
ILegendClass |
esri_getClass(int index)
Legend class at the specified index. |
int |
getClassCount()
Number of legend classes in the group. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.String |
getClsid()
getClsid. |
java.lang.String |
getColorRampName()
Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors. |
java.lang.String |
getDescription()
Text description of the temporal legend group. |
java.lang.String |
getHeading()
String heading. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
ITemporalLegendClass |
getTemporalLegendClass(int nRangeNdx)
Temporal Legend Class at specified index from this group. |
java.lang.String |
getUID()
A unique ID to represent the type of legend group. |
int |
hashCode()
the hashcode for this object |
void |
insertClass(int index,
ILegendClass legendClass)
Inserts a new legend class into the group at the specified index. |
void |
interfaceSupportsErrorInfo(GUID riid)
interfaceSupportsErrorInfo |
int |
intersects(java.lang.Object pvTimeValue,
ISymbol[] ppiSymbol,
IColor[] ppiSymbolColor,
double[] pdSymbolSize)
Determines whether a given timestamp value is contained within one of the group's temporal classes. |
void |
isDirty()
isDirty |
boolean |
isEditable()
Indicates if the group can be edited. |
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 |
isSupportedAtVersion(int docVersion)
Is this object valid at the given document version. |
boolean |
isSuppress()
Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query. |
boolean |
isUseGradient()
Create a smooth gradient using the symbols in the first two classes. |
boolean |
isVisible()
Indicates if the group is displayed. |
void |
load(IStream pstm)
load |
void |
moveClass(int nCurrentIndex,
int nDestinationIndex)
Moves a temporal legend class from its current position to a new destination within the temporal legend group's legend class container. |
void |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a TemporalLegendGroup. |
void |
removeClass(int index)
Removes the legend class from the group at the specified index. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setColorRampName(java.lang.String pbstrColorRampName)
Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors. |
void |
setDescription(java.lang.String pbstrDescription)
Text description of the temporal legend group. |
void |
setEditable(boolean editable)
Indicates if the group can be edited. |
void |
setHeading(java.lang.String heading)
String heading. |
void |
setReference(java.lang.Object varReference)
Sets temporal reference information for the temporal legend group. |
void |
setSuppress(boolean pbSuppress)
Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query. |
void |
setUID(java.lang.String uID)
A unique ID to represent the type of legend group. |
void |
setUseGradient(boolean useGradient)
Create a smooth gradient using the symbols in the first two classes. |
void |
setVisible(boolean visible)
Indicates if the group is displayed. |
void |
update()
Updates the temporal legend with new values. |
void |
verify(boolean[] bNoProblems)
Checks ranges within a group to determine if group is ordered properly and has correct offsets. |
void |
writeExternal(java.io.ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final long serialVersionUID
| Constructor Detail |
|---|
public TemporalLegendGroup()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public TemporalLegendGroup(java.lang.Object obj)
throws java.io.IOException
TemporalLegendGroup theTemporalLegendGroup = (TemporalLegendGroup) obj;
obj to TemporalLegendGroup.
obj - an object returned from ArcGIS Engine or Server
java.io.IOException - if there are interop problems| Method Detail |
|---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRefpublic void release()
release in interface com.esri.arcgis.interop.RemoteObjRef
public boolean isVisible()
throws java.io.IOException,
AutomationException
isVisible in interface ILegendGroupisVisible in interface ITemporalLegendGroupjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setVisible(boolean visible)
throws java.io.IOException,
AutomationException
setVisible in interface ILegendGroupsetVisible in interface ITemporalLegendGroupvisible - The visible (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEditable()
throws java.io.IOException,
AutomationException
isEditable in interface ILegendGroupisEditable in interface ITemporalLegendGroupjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEditable(boolean editable)
throws java.io.IOException,
AutomationException
setEditable in interface ILegendGroupsetEditable in interface ITemporalLegendGroupeditable - The editable (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getHeading()
throws java.io.IOException,
AutomationException
getHeading in interface ILegendGroupgetHeading in interface ITemporalLegendGroupjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setHeading(java.lang.String heading)
throws java.io.IOException,
AutomationException
setHeading in interface ILegendGroupsetHeading in interface ITemporalLegendGroupheading - The heading (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getClassCount()
throws java.io.IOException,
AutomationException
getClassCount in interface ILegendGroupgetClassCount in interface ITemporalLegendGroupjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILegendClass esri_getClass(int index)
throws java.io.IOException,
AutomationException
esri_getClass in interface ILegendGroupesri_getClass in interface ITemporalLegendGroupindex - The index (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addClass(ILegendClass legendClass)
throws java.io.IOException,
AutomationException
addClass in interface ILegendGroupaddClass in interface ITemporalLegendGrouplegendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void insertClass(int index,
ILegendClass legendClass)
throws java.io.IOException,
AutomationException
insertClass in interface ILegendGroupinsertClass in interface ITemporalLegendGroupindex - The index (in)legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeClass(int index)
throws java.io.IOException,
AutomationException
removeClass in interface ILegendGroupremoveClass in interface ITemporalLegendGroupindex - The index (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void clearClasses()
throws java.io.IOException,
AutomationException
clearClasses in interface ILegendGroupclearClasses in interface ITemporalLegendGroupjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getColorRampName()
throws java.io.IOException,
AutomationException
getColorRampName in interface ITemporalLegendGroupjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setColorRampName(java.lang.String pbstrColorRampName)
throws java.io.IOException,
AutomationException
setColorRampName in interface ITemporalLegendGrouppbstrColorRampName - The pbstrColorRampName (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getDescription()
throws java.io.IOException,
AutomationException
getDescription in interface ITemporalLegendGroupjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDescription(java.lang.String pbstrDescription)
throws java.io.IOException,
AutomationException
setDescription in interface ITemporalLegendGrouppbstrDescription - The pbstrDescription (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITemporalLegendClass getTemporalLegendClass(int nRangeNdx)
throws java.io.IOException,
AutomationException
getTemporalLegendClass in interface ITemporalLegendGroupnRangeNdx - The nRangeNdx (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSuppress()
throws java.io.IOException,
AutomationException
isSuppress in interface ITemporalLegendGroupjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSuppress(boolean pbSuppress)
throws java.io.IOException,
AutomationException
setSuppress in interface ITemporalLegendGrouppbSuppress - The pbSuppress (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReference(java.lang.Object varReference)
throws java.io.IOException,
AutomationException
setReference in interface ITemporalLegendGroupvarReference - A Variant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int intersects(java.lang.Object pvTimeValue,
ISymbol[] ppiSymbol,
IColor[] ppiSymbolColor,
double[] pdSymbolSize)
throws java.io.IOException,
AutomationException
intersects in interface ITemporalLegendGrouppvTimeValue - A Variant (in)ppiSymbol - A reference to a com.esri.arcgis.display.ISymbol (in/out: use single element array)ppiSymbolColor - A reference to a com.esri.arcgis.display.IColor (in/out: use single element array)pdSymbolSize - The pdSymbolSize (in/out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void update()
throws java.io.IOException,
AutomationException
update in interface ITemporalLegendGroupjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void moveClass(int nCurrentIndex,
int nDestinationIndex)
throws java.io.IOException,
AutomationException
moveClass in interface ITemporalLegendGroupnCurrentIndex - The nCurrentIndex (in)nDestinationIndex - The nDestinationIndex (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void verify(boolean[] bNoProblems)
throws java.io.IOException,
AutomationException
verify in interface ITemporalLegendGroupbNoProblems - The bNoProblems (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isUseGradient()
throws java.io.IOException,
AutomationException
isUseGradient in interface ITemporalLegendGroup2java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseGradient(boolean useGradient)
throws java.io.IOException,
AutomationException
setUseGradient in interface ITemporalLegendGroup2useGradient - The useGradient (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getUID()
throws java.io.IOException,
AutomationException
getUID in interface ITemporalLegendGroup2java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUID(java.lang.String uID)
throws java.io.IOException,
AutomationException
setUID in interface ITemporalLegendGroup2uID - The uID (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws java.io.IOException,
AutomationException
isDirty in interface IPersistStreamjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws java.io.IOException,
AutomationException
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws java.io.IOException,
AutomationException
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws java.io.IOException,
AutomationException
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws java.io.IOException,
AutomationException
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IClone esri_clone()
throws java.io.IOException,
AutomationException
esri_clone in interface IClonejava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void assign(IClone src)
throws java.io.IOException,
AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEqual(IClone other)
throws java.io.IOException,
AutomationException
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIdentical(IClone other)
throws java.io.IOException,
AutomationException
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void interfaceSupportsErrorInfo(GUID riid)
throws java.io.IOException,
AutomationException
interfaceSupportsErrorInfo in interface ISupportErrorInforiid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSupportedAtVersion(int docVersion)
throws java.io.IOException,
AutomationException
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.
isSupportedAtVersion in interface IDocumentVersionSupportGENdocVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.Object convertToSupportedObject(int docVersion)
throws java.io.IOException,
AutomationException
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.
convertToSupportedObject in interface IDocumentVersionSupportGENdocVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(java.io.ObjectOutput out)
throws java.io.IOException
writeExternal in interface java.io.Externalizablejava.io.IOException
public void readExternal(java.io.ObjectInput in)
throws java.io.IOException,
java.lang.ClassNotFoundException
readExternal in interface java.io.Externalizablejava.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||