Packagecom.mapquest
Classpublic class DTStyle
InheritanceDTStyle Inheritance BaseDTStyle Inheritance MQObject

Contains the appearance characteristics of all features for a given display type. These characteristics include the icon name, icon type (Raster or Metafile), icon visible, label visible, low scale index, and high scale index. The scale indexes indicate the range of map scales at which the display type style applies. If the user desires to create his own icon, it must be a .BMP, which is a raster image. In order to modify feature types other than points or use complex style descriptions, use the Style File Editor application to design complex styles to use with the DTStyleEx class. The Style File Editor application can export complex styles as map style strings. The DTStyleEx class has all the functionality described for DTStyle, and additionally can modify or add styles for point, line, and polygon map features using map style strings.


Public Properties
 PropertyDefined by
 InheritedCLASS_NAME : String = "MQObject"
[static]
MQObject
Protected Properties
 PropertyDefined by
 InheritedobjectVersion : Number = 0
Value to represent the version of this object
MQObject
 Inheritedxml : XML = null
MQObject
 Inheritedxpath : String
MQObject
Public Methods
 MethodDefined by
  
DTStyle()
Constructs a new DTStyle object.
DTStyle
 Inherited
equals(type:BaseDTStyle):Boolean
Checks the equality of the values of two BaseDTStyle objects.
BaseDTStyle
  
getClassName():String
Returns the text name of this class.
DTStyle
 Inherited
getDT():int
Returns the DT of this object.
BaseDTStyle
  
getFontBoxBkgdColor():ColorStyle
Gets the FontBoxBkgdColor.
DTStyle
  
getFontBoxMargin():int
Returns the FontBoxMargin of this object.
DTStyle
  
getFontBoxOutlineColor():ColorStyle
Gets the FontBoxOutlineColor.
DTStyle
  
getFontColor():ColorStyle
Gets the color.
DTStyle
  
getFontName():String
Returns the FontName of this object.
DTStyle
  
getFontOutlineColor():ColorStyle
Gets the FontOutlineColor.
DTStyle
  
getFontSize():int
Returns the FontSize of this object.
DTStyle
  
getFontStyle():FontStyle
Gets the font.
DTStyle
 Inherited
getHighScale():int
Returns the HighScale of this object.
BaseDTStyle
  
getLabelVisible():Boolean
Gets the LabelVisible flag
DTStyle
 Inherited
getLowScale():int
Returns the LowScale of this object.
BaseDTStyle
  
getObjectVersion():Number
Returns the version of this class.
DTStyle
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
  
getSymbolName():String
Returns the SymbolName of this object.
DTStyle
  
getSymbolType():SymbolType
Gets the color.
DTStyle
  
getVisible():Boolean
Gets the Visible flag
DTStyle
 Inherited
internalCopy(obj:MQObject):MQObject
Create a copy of this object.
MQObject
 Inherited
internalCopyXML(obj:MQObject):XML
MQObject
 Inherited
internalCopyXMLx(obj:MQObject):String
MQObject
  
loadXml(xmlPrm:XML):void
Assigns the xml that relates to this object.
DTStyle
 Inherited
readExternal(input:IDataInput):void
MQObject
  
saveXml():XML
Build an xml string that represents this object.
DTStyle
 Inherited
setDT(val:int):void
Sets the DT of this object.
BaseDTStyle
  
setFontBoxBkgdColor(obj:ColorStyle):void
Sets the FontBoxBkgdColor.
DTStyle
  
setFontBoxMargin(val:int):void
Sets the FontBoxMargin of this object.
DTStyle
  
setFontBoxOutlineColor(obj:ColorStyle):void
Sets the FontBoxOutlineColor.
DTStyle
  
setFontColor(obj:ColorStyle):void
Sets the color.
DTStyle
  
setFontName(val:String):void
Sets the FontName of this object.
DTStyle
  
setFontOutlineColor(obj:ColorStyle):void
Sets the FontOutlineColor.
DTStyle
  
setFontSize(val:int):void
Sets the FontSize of this object.
DTStyle
  
setFontStyle(obj:FontStyle):void
Sets the font.
DTStyle
 Inherited
setHighScale(val:int):void
Sets the HighScale of this object.
BaseDTStyle
  
setLabelVisible(bFlag:Boolean):void
Sets the LabelVisible flag.
DTStyle
 Inherited
setLowScale(val:int):void
Sets the LowScale of this object.
BaseDTStyle
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
  
setSymbolName(val:String):void
Sets the SymbolName of this object.
DTStyle
  
setSymbolType(obj:SymbolType):void
Sets the color.
DTStyle
  
setVisible(bFlag:Boolean):void
Sets the Visible flag.
DTStyle
 Inherited
setXpath(xpath:String):void
Sets the m_xpath object.
MQObject
 Inherited
writeExternal(output:IDataOutput):void
MQObject
Protected Methods
 MethodDefined by
 Inherited
getXML():XML
Returns the m_xmlDoc object.
MQObject
 Inherited
getXpath():String
Returns the xpath string.
MQObject
 Inherited
setXML(xml:XML):void
Sets the m_xmlDoc object.
MQObject
Constructor detail
DTStyle()constructor
public function DTStyle()

Constructs a new DTStyle object.

Method detail
getClassName()method
public override function getClassName():String

Returns the text name of this class.

Returns
String — The text name of this class.
getFontBoxBkgdColor()method 
public function getFontBoxBkgdColor():ColorStyle

Gets the FontBoxBkgdColor.

Returns
ColorStyle — The m_FontBoxBkgdColor type.
getFontBoxMargin()method 
public function getFontBoxMargin():int

Returns the FontBoxMargin of this object.

Returns
int — The new FontBoxMargin of this object.
getFontBoxOutlineColor()method 
public function getFontBoxOutlineColor():ColorStyle

Gets the FontBoxOutlineColor.

Returns
ColorStyle — The m_FontBoxOutlineColor type.
getFontColor()method 
public function getFontColor():ColorStyle

Gets the color.

Returns
ColorStyle — The m_FontColor type.
getFontName()method 
public function getFontName():String

Returns the FontName of this object.

Returns
String — The new FontName of this object.
getFontOutlineColor()method 
public function getFontOutlineColor():ColorStyle

Gets the FontOutlineColor.

Returns
ColorStyle — The m_FontOutlineColor type.
getFontSize()method 
public function getFontSize():int

Returns the FontSize of this object.

Returns
int — The new FontSize of this object.
getFontStyle()method 
public function getFontStyle():FontStyle

Gets the font.

Returns
FontStyle — The m_FontStyle type.
getLabelVisible()method 
public function getLabelVisible():Boolean

Gets the LabelVisible flag

Returns
Boolean — true if a LabelVisible = 1, false otherwise.
getObjectVersion()method 
public override function getObjectVersion():Number

Returns the version of this class.

Returns
Number — The version of this class.
getSymbolName()method 
public function getSymbolName():String

Returns the SymbolName of this object.

Returns
String — The new SymbolName of this object.
getSymbolType()method 
public function getSymbolType():SymbolType

Gets the color.

Returns
SymbolType — The m_SymbolType type.
getVisible()method 
public function getVisible():Boolean

Gets the Visible flag

Returns
Boolean — true if a Visible = 1, false otherwise.
loadXml()method 
public override function loadXml(xmlPrm:XML):void

Assigns the xml that relates to this object.

Parameters
xmlPrm:XML — strXml the xml to be assigned.
saveXml()method 
public override function saveXml():XML

Build an xml string that represents this object.

Returns
XML — The xml string.
setFontBoxBkgdColor()method 
public function setFontBoxBkgdColor(obj:ColorStyle):void

Sets the FontBoxBkgdColor.

Parameters
obj:ColorStyle — obj The ColorStyle to set m_FontBoxBkgdColor type to.
setFontBoxMargin()method 
public function setFontBoxMargin(val:int):void

Sets the FontBoxMargin of this object.

Parameters
val:int — The new FontBoxMargin of this object.
setFontBoxOutlineColor()method 
public function setFontBoxOutlineColor(obj:ColorStyle):void

Sets the FontBoxOutlineColor.

Parameters
obj:ColorStyle — obj The ColorStyle to set m_FontBoxOutlineColor type to.
setFontColor()method 
public function setFontColor(obj:ColorStyle):void

Sets the color.

Parameters
obj:ColorStyle — obj The ColorStyle to set m_FontColor type to.
setFontName()method 
public function setFontName(val:String):void

Sets the FontName of this object.

Parameters
val:String — val The new FontName of this object.
setFontOutlineColor()method 
public function setFontOutlineColor(obj:ColorStyle):void

Sets the FontOutlineColor.

Parameters
obj:ColorStyle — obj The ColorStyle to set m_FontOutlineColor type to.
setFontSize()method 
public function setFontSize(val:int):void

Sets the FontSize of this object.

Parameters
val:int — val The new FontSize of this object.
setFontStyle()method 
public function setFontStyle(obj:FontStyle):void

Sets the font.

Parameters
obj:FontStyle — obj The FontStyle to set m_FontStyle type to.
setLabelVisible()method 
public function setLabelVisible(bFlag:Boolean):void

Sets the LabelVisible flag.

Parameters
bFlag:Boolean — The LabelVisible flag
setSymbolName()method 
public function setSymbolName(val:String):void

Sets the SymbolName of this object.

Parameters
val:String — val The new SymbolName of this object.
setSymbolType()method 
public function setSymbolType(obj:SymbolType):void

Sets the color.

Parameters
obj:SymbolType — obj The SymbolType to set m_SymbolType type to.
setVisible()method 
public function setVisible(bFlag:Boolean):void

Sets the Visible flag.

Parameters
bFlag:Boolean — The Visible flag