com.esri.arcgis.schematic
Class NgTextualProperty

java.lang.Object
  extended by com.esri.arcgis.schematic.NgTextualProperty
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INgProperty, INgTextualProperty, Serializable

public class NgTextualProperty
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgTextualProperty, INgProperty

Graphic textual property object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NgTextualProperty(Object obj)
          Construct a NgTextualProperty using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void delete()
          Deletes the property.
 boolean equals(Object o)
          Compare this object with another
 INgAttribute getAssociatedAttribute()
          Attribute the property is associated with.
 INgFlagModel getDisplayFlagModel()
          Flag model used by the property.
 Object getEffect(int effect)
          Returns the effect 'effect' set for the property (see esriNgPropertyEffect).
 INgElementType getElementType()
          Element type the textual property applies to.
 String getName()
          Name of the textual property.
 int getType()
          Type of the property (see esriNgPropertyType).
 int hashCode()
          the hashcode for this object
 boolean isEffectSet(int effect)
          Indicates if the effect 'effect' related to the property is set (see esriNgPropertyEffect).
 void removeEffect(int effect)
          Removes the effect or restores the default effect 'effect' set for the property (see esriNgPropertyEffect).
 void setDisplayFlagModel(INgFlagModel pVal)
          Flag model used by the property.
 void setEffect(int effect, Object effValue)
          Modifies the effect 'effect' set for the property (see esriNgPropertyEffect).
 void setName(String pVal)
          Name of the textual property.
 
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

NgTextualProperty

public NgTextualProperty(Object obj)
                  throws IOException
Construct a NgTextualProperty using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgTextualProperty.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
NgTextualProperty o = (NgTextualProperty)obj; // will not work

NgTextualProperty o = new NgTextualProperty(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems NgTextualProperty theNgTextualProperty = (NgTextualProperty) obj;
Method Detail

equals

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

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the textual property.

Description

This name is defined when the textual property is created

- Either by calling the INgElementType CreateProperty method in the program code,

- Or when it is created through ArcGIS Schematics Designer GUI

Product Availability

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

Specified by:
getName in interface INgProperty
Specified by:
getName in interface INgTextualProperty
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the textual property.

Product Availability

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

Specified by:
setName in interface INgProperty
Specified by:
setName in interface INgTextualProperty
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementType

public INgElementType getElementType()
                              throws IOException,
                                     AutomationException
Element type the textual property applies to.

Product Availability

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

Specified by:
getElementType in interface INgProperty
Specified by:
getElementType in interface INgTextualProperty
Returns:
A reference to a com.esri.arcgis.schematic.INgElementType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgElementType.createProperty(String, int, int, int)

getType

public int getType()
            throws IOException,
                   AutomationException
Type of the property (see esriNgPropertyType).

Product Availability

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

Specified by:
getType in interface INgProperty
Returns:
A com.esri.arcgis.schematic.esriNgPropertyType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEffect

public Object getEffect(int effect)
                 throws IOException,
                        AutomationException
Returns the effect 'effect' set for the property (see esriNgPropertyEffect).

Product Availability

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

Specified by:
getEffect in interface INgProperty
Parameters:
effect - A com.esri.arcgis.schematic.esriNgPropertyEffect constant (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProperty.isEffectSet(int), INgProperty.removeEffect(int), INgProperty.setEffect(int, java.lang.Object)

setEffect

public void setEffect(int effect,
                      Object effValue)
               throws IOException,
                      AutomationException
Modifies the effect 'effect' set for the property (see esriNgPropertyEffect).

Product Availability

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

Specified by:
setEffect in interface INgProperty
Parameters:
effect - A com.esri.arcgis.schematic.esriNgPropertyEffect constant (in)
effValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProperty.isEffectSet(int), INgProperty.removeEffect(int), INgProperty.getEffect(int)

removeEffect

public void removeEffect(int effect)
                  throws IOException,
                         AutomationException
Removes the effect or restores the default effect 'effect' set for the property (see esriNgPropertyEffect).

Description

Note that when removing an effect that is always set, the ;property default effect value is automatically restored; and removing an effect that is not set by default, really removes the property effect.

Product Availability

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

Specified by:
removeEffect in interface INgProperty
Parameters:
effect - A com.esri.arcgis.schematic.esriNgPropertyEffect constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProperty.isEffectSet(int), INgProperty.setEffect(int, java.lang.Object), INgProperty.getEffect(int)

isEffectSet

public boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException
Indicates if the effect 'effect' related to the property is set (see esriNgPropertyEffect).

Description

By default, Schematics automatically sets default values for some property effects (see the List of the property effect default values, below). For all these effects, the IsEffectSet method returns True. For the other effects (those that are not automatically set by default), the IsEffectSet method returns True only if the effect has been set:

- Either when defining the property's characteristics in ArcGIS Schematics Designer

- Or by calling the SetEffect method in the project code.


List of the property effect default values

esriNgPropertyDecimalPrecision: -1

esriNgPropertyLabelDisplayMode: esriNgDisplayPropertyValue

esriNgPropertyLabelPlacement: esriNgAbove

esriNgPropertyLabelPort: 0

esriNgPropertyLegendNotes: nothing. But, by default, Schematics displays the property name

esriNgPropertyLegendVisibility: esriNgVisible

esriNgPropertyStatus: esriNgEnabled

esriNgPropertyStringLenght: -1

esriNgPropertyValueType: esriNgFloatPropertyValue, esriNgIntegerPropertyValue or esriNgStringPropertyValue. This parameter is fixed when the property is created.


For more details, see Property Effects Definition.

Product Availability

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

Specified by:
isEffectSet in interface INgProperty
Parameters:
effect - A com.esri.arcgis.schematic.esriNgPropertyEffect constant (in)
Returns:
The isSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProperty.removeEffect(int), INgProperty.setEffect(int, java.lang.Object), INgProperty.getEffect(int)

getDisplayFlagModel

public INgFlagModel getDisplayFlagModel()
                                 throws IOException,
                                        AutomationException
Flag model used by the property.

Product Availability

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

Specified by:
getDisplayFlagModel in interface INgProperty
Returns:
A reference to a com.esri.arcgis.schematic.INgFlagModel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayFlagModel

public void setDisplayFlagModel(INgFlagModel pVal)
                         throws IOException,
                                AutomationException
Flag model used by the property.

Product Availability

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

Specified by:
setDisplayFlagModel in interface INgProperty
Parameters:
pVal - A reference to a com.esri.arcgis.schematic.INgFlagModel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException
Deletes the property.

Product Availability

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

Specified by:
delete in interface INgProperty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgElementType.createProperty(String, int, int, int)

getAssociatedAttribute

public INgAttribute getAssociatedAttribute()
                                    throws IOException,
                                           AutomationException
Attribute the property is associated with.

Product Availability

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

Specified by:
getAssociatedAttribute in interface INgProperty
Returns:
A reference to a com.esri.arcgis.schematic.INgAttribute
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgElementType.getAssociatedPropertyAttribute(String)