Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgisws
Class TextSymbol

java.lang.Object
  extended by com.esri.arcgisws.Symbol
      extended by com.esri.arcgisws.TextSymbol
All Implemented Interfaces:
Serializable
public class TextSymbol
extends Symbol
implements Serializable

Java class for TextSymbol complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="TextSymbol">
   <complexContent>
     <extension base="{http://www.esri.com/schemas/ArcGIS/10.0}Symbol">
       <sequence>
         <element name="Color" type="{http://www.esri.com/schemas/ArcGIS/10.0}Color" minOccurs="0"/>
         <element name="BreakCharIndex" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="VerticalAlignment" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriTextVerticalAlignment"/>
         <element name="HorizontalAlignment" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriTextHorizontalAlignment"/>
         <element name="Clip" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="RightToLeft" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="Angle" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="XOffset" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="YOffset" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="ShadowColor" type="{http://www.esri.com/schemas/ArcGIS/10.0}Color" minOccurs="0"/>
         <element name="ShadowXOffset" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="ShadowYOffset" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="TextPosition" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriTextPosition"/>
         <element name="TextCase" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriTextCase"/>
         <element name="CharacterSpacing" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="CharacterWidth" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="WordSpacing" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="Kerning" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="Leading" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="TextDirection" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriTextDirection"/>
         <element name="FlipAngle" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="TypeSetting" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="TextPathClass" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="FillSymbol" type="{http://www.esri.com/schemas/ArcGIS/10.0}Symbol" minOccurs="0"/>
         <element name="Text" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="Size" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="MaskStyle" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriMaskStyle"/>
         <element name="MaskSize" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="MaskSymbol" type="{http://www.esri.com/schemas/ArcGIS/10.0}Symbol" minOccurs="0"/>
         <element name="FontName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="FontItalic" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="FontUnderline" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="FontStrikethrough" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="FontWeight" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="FontCharset" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="FontSizeHi" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="FontSizeLo" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="TextParserClass" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

See Also:
Serialized Form

Constructor Summary
TextSymbol()
          TextSymbol default constructor.
TextSymbol(Color color, int breakCharIndex, EsriTextVerticalAlignment verticalAlignment, EsriTextHorizontalAlignment horizontalAlignment, boolean clip, boolean rightToLeft, double angle, double xOffset, double yOffset, Color shadowColor, double shadowXOffset, double shadowYOffset, EsriTextPosition textPosition, EsriTextCase textCase, double characterSpacing, double characterWidth, double wordSpacing, boolean kerning, double leading, EsriTextDirection textDirection, double flipAngle, boolean typeSetting, String textPathClass, Symbol fillSymbol, String text, double size, EsriMaskStyle maskStyle, double maskSize, Symbol maskSymbol, String fontName, Boolean fontItalic, Boolean fontUnderline, Boolean fontStrikethrough, Integer fontWeight, Integer fontCharset, Integer fontSizeHi, Integer fontSizeLo, String textParserClass)
          Deprecated. 
 
Method Summary
 double getAngle()
          Text baseline angle.
 int getBreakCharIndex()
          Character to be interpreted as text line end.
 double getCharacterSpacing()
          Gets the value of the characterSpacing property.
 double getCharacterWidth()
          Gets the value of the characterWidth property.
 Color getColor()
          Text color." Gets the value of the color property.
 Symbol getFillSymbol()
          Gets the value of the fillSymbol property.
 double getFlipAngle()
          Gets the value of the flipAngle property.
 Integer getFontCharset()
          The character set used in the font, such as ANSI_CHARSET, DEFAULT_CHARSET, or SYMBOL_CHARSET.
 Boolean getFontItalic()
          Indicates whether the font is italicized.
 String getFontName()
          The name of the font family.
 Integer getFontSizeHi()
          Point size of the font expressed in a 64-bit CY variable whose upper 32-bits contains the integer point size.
 Integer getFontSizeLo()
          Point size of the font expressed in a 64-bit CY variable whose lower 32-bits contains the fractional point size.
 Boolean getFontStrikethrough()
          Indicates whether the font is strikethrough.
 Boolean getFontUnderline()
          Indicates whether the font is underlined.
 Integer getFontWeight()
          The boldness or weight of the font.
 EsriTextHorizontalAlignment getHorizontalAlignment()
          Horizontal alignment style.
 double getLeading()
          Gets the value of the leading property.
 double getMaskSize()
          Gets the value of the maskSize property.
 EsriMaskStyle getMaskStyle()
          Gets the value of the maskStyle property.
 Symbol getMaskSymbol()
          Gets the value of the maskSymbol property.
 Color getShadowColor()
          Gets the value of the shadowColor property.
 double getShadowXOffset()
          Gets the value of the shadowXOffset property.
 double getShadowYOffset()
          Gets the value of the shadowYOffset property.
 double getSize()
          Text size.
 String getText()
          Text to draw.
 EsriTextCase getTextCase()
          The text case.
 EsriTextDirection getTextDirection()
          The text direction.
 String getTextParserClass()
          Text Parser Class ID Gets the value of the textParserClass property.
 String getTextPathClass()
          Path of text baseline.
 EsriTextPosition getTextPosition()
          The text position.
 EsriTextVerticalAlignment getVerticalAlignment()
          Vertical alignment style.
 double getWordSpacing()
          Gets the value of the wordSpacing property.
 double getXOffset()
          Gets the value of the xOffset property.
 double getYOffset()
          Gets the value of the yOffset property.
 boolean isClip()
          Gets the value of the clip property.
 Boolean isFontItalic()
          Indicates whether the font is italicized.
 Boolean isFontStrikethrough()
          Indicates whether the font is strikethrough.
 Boolean isFontUnderline()
          Indicates whether the font is underlined.
 boolean isKerning()
          Gets the value of the kerning property.
 boolean isRightToLeft()
          Indicates if the text is drawn from right to left.
 boolean isTypeSetting()
          Gets the value of the typeSetting property.
 void setAngle(double value)
          Text baseline angle.
 void setBreakCharIndex(int value)
          Character to be interpreted as text line end.
 void setCharacterSpacing(double value)
          Sets the value of the characterSpacing property.
 void setCharacterWidth(double value)
          Sets the value of the characterWidth property.
 void setClip(boolean value)
          Sets the value of the clip property.
 void setColor(Color value)
          Text color." Sets the value of the color property.
 void setFillSymbol(Symbol value)
          Sets the value of the fillSymbol property.
 void setFlipAngle(double value)
          Sets the value of the flipAngle property.
 void setFontCharset(Integer value)
          Sets the value of the fontCharset property.
 void setFontItalic(Boolean value)
          Indicates whether the font is italicized.
 void setFontName(String value)
          The name of the font family.
 void setFontSizeHi(Integer value)
          Point size of the font expressed in a 64-bit CY variable whose upper 32-bits contains the integer point size.
 void setFontSizeLo(Integer value)
          Point size of the font expressed in a 64-bit CY variable whose lower 32-bits contains the fractional point size.
 void setFontStrikethrough(Boolean value)
          Indicates whether the font is strikethrough.
 void setFontUnderline(Boolean value)
          Indicates whether the font is underlined.
 void setFontWeight(Integer value)
          The boldness or weight of the font.
 void setHorizontalAlignment(EsriTextHorizontalAlignment value)
          Horizontal alignment style.
 void setKerning(boolean value)
          Sets the value of the kerning property.
 void setLeading(double value)
          Sets the value of the leading property.
 void setMaskSize(double value)
          Sets the value of the maskSize property.
 void setMaskStyle(EsriMaskStyle value)
          Sets the value of the maskStyle property.
 void setMaskSymbol(Symbol value)
          Sets the value of the maskSymbol property.
 void setRightToLeft(boolean value)
          Indicates if the text is drawn from right to left.
 void setShadowColor(Color value)
          Sets the value of the shadowColor property.
 void setShadowXOffset(double value)
          Sets the value of the shadowXOffset property.
 void setShadowYOffset(double value)
          Sets the value of the shadowYOffset property.
 void setSize(double value)
          Text size.
 void setText(String value)
          Text to draw.
 void setTextCase(EsriTextCase value)
          The text case.
 void setTextDirection(EsriTextDirection value)
          The text direction.
 void setTextParserClass(String value)
          Text Parser Class ID Sets the value of the textParserClass property.
 void setTextPathClass(String value)
          Path of text baseline.
 void setTextPosition(EsriTextPosition value)
          The text position.
 void setTypeSetting(boolean value)
          Sets the value of the typeSetting property.
 void setVerticalAlignment(EsriTextVerticalAlignment value)
          Vertical alignment style.
 void setWordSpacing(double value)
          Sets the value of the wordSpacing property.
 void setXOffset(double value)
          Sets the value of the xOffset property.
 void setYOffset(double value)
          Sets the value of the yOffset property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextSymbol

@Deprecated
public TextSymbol(Color color,
                             int breakCharIndex,
                             EsriTextVerticalAlignment verticalAlignment,
                             EsriTextHorizontalAlignment horizontalAlignment,
                             boolean clip,
                             boolean rightToLeft,
                             double angle,
                             double xOffset,
                             double yOffset,
                             Color shadowColor,
                             double shadowXOffset,
                             double shadowYOffset,
                             EsriTextPosition textPosition,
                             EsriTextCase textCase,
                             double characterSpacing,
                             double characterWidth,
                             double wordSpacing,
                             boolean kerning,
                             double leading,
                             EsriTextDirection textDirection,
                             double flipAngle,
                             boolean typeSetting,
                             String textPathClass,
                             Symbol fillSymbol,
                             String text,
                             double size,
                             EsriMaskStyle maskStyle,
                             double maskSize,
                             Symbol maskSymbol,
                             String fontName,
                             Boolean fontItalic,
                             Boolean fontUnderline,
                             Boolean fontStrikethrough,
                             Integer fontWeight,
                             Integer fontCharset,
                             Integer fontSizeHi,
                             Integer fontSizeLo,
                             String textParserClass)
Deprecated. 

TextSymbol constructor.

TextSymbol

public TextSymbol()
TextSymbol default constructor.

Method Detail

getColor

public Color getColor()
Text color." Gets the value of the color property.

Returns:
possible object is Color

setColor

public void setColor(Color value)
Text color." Sets the value of the color property.

Parameters:
value - allowed object is Color

getBreakCharIndex

public int getBreakCharIndex()
Character to be interpreted as text line end. Gets the value of the breakCharIndex property.

setBreakCharIndex

public void setBreakCharIndex(int value)
Character to be interpreted as text line end. Sets the value of the breakCharIndex property.

getVerticalAlignment

public EsriTextVerticalAlignment getVerticalAlignment()
Vertical alignment style. Gets the value of the verticalAlignment property.

Returns:
possible object is EsriTextVerticalAlignment

setVerticalAlignment

public void setVerticalAlignment(EsriTextVerticalAlignment value)
Vertical alignment style. Sets the value of the verticalAlignment property.

Parameters:
value - allowed object is EsriTextVerticalAlignment

getHorizontalAlignment

public EsriTextHorizontalAlignment getHorizontalAlignment()
Horizontal alignment style. Gets the value of the horizontalAlignment property.

Returns:
possible object is EsriTextHorizontalAlignment

setHorizontalAlignment

public void setHorizontalAlignment(EsriTextHorizontalAlignment value)
Horizontal alignment style. Sets the value of the horizontalAlignment property.

Parameters:
value - allowed object is EsriTextHorizontalAlignment

isClip

public boolean isClip()
Gets the value of the clip property.

setClip

public void setClip(boolean value)
Sets the value of the clip property.

isRightToLeft

public boolean isRightToLeft()
Indicates if the text is drawn from right to left. Gets the value of the rightToLeft property.

setRightToLeft

public void setRightToLeft(boolean value)
Indicates if the text is drawn from right to left. Sets the value of the rightToLeft property.

getAngle

public double getAngle()
Text baseline angle. Gets the value of the angle property.

setAngle

public void setAngle(double value)
Text baseline angle. Sets the value of the angle property.

getXOffset

public double getXOffset()
Gets the value of the xOffset property.

setXOffset

public void setXOffset(double value)
Sets the value of the xOffset property.

getYOffset

public double getYOffset()
Gets the value of the yOffset property.

setYOffset

public void setYOffset(double value)
Sets the value of the yOffset property.

getShadowColor

public Color getShadowColor()
Gets the value of the shadowColor property.

Returns:
possible object is Color

setShadowColor

public void setShadowColor(Color value)
Sets the value of the shadowColor property.

Parameters:
value - allowed object is Color

getShadowXOffset

public double getShadowXOffset()
Gets the value of the shadowXOffset property.

setShadowXOffset

public void setShadowXOffset(double value)
Sets the value of the shadowXOffset property.

getShadowYOffset

public double getShadowYOffset()
Gets the value of the shadowYOffset property.

setShadowYOffset

public void setShadowYOffset(double value)
Sets the value of the shadowYOffset property.

getTextPosition

public EsriTextPosition getTextPosition()
The text position. Gets the value of the textPosition property.

Returns:
possible object is EsriTextPosition

setTextPosition

public void setTextPosition(EsriTextPosition value)
The text position. Sets the value of the textPosition property.

Parameters:
value - allowed object is EsriTextPosition

getTextCase

public EsriTextCase getTextCase()
The text case. Gets the value of the textCase property.

Returns:
possible object is EsriTextCase

setTextCase

public void setTextCase(EsriTextCase value)
The text case. Sets the value of the textCase property.

Parameters:
value - allowed object is EsriTextCase

getCharacterSpacing

public double getCharacterSpacing()
Gets the value of the characterSpacing property.

setCharacterSpacing

public void setCharacterSpacing(double value)
Sets the value of the characterSpacing property.

getCharacterWidth

public double getCharacterWidth()
Gets the value of the characterWidth property.

setCharacterWidth

public void setCharacterWidth(double value)
Sets the value of the characterWidth property.

getWordSpacing

public double getWordSpacing()
Gets the value of the wordSpacing property.

setWordSpacing

public void setWordSpacing(double value)
Sets the value of the wordSpacing property.

isKerning

public boolean isKerning()
Gets the value of the kerning property.

setKerning

public void setKerning(boolean value)
Sets the value of the kerning property.

getLeading

public double getLeading()
Gets the value of the leading property.

setLeading

public void setLeading(double value)
Sets the value of the leading property.

getTextDirection

public EsriTextDirection getTextDirection()
The text direction. Gets the value of the textDirection property.

Returns:
possible object is EsriTextDirection

setTextDirection

public void setTextDirection(EsriTextDirection value)
The text direction. Sets the value of the textDirection property.

Parameters:
value - allowed object is EsriTextDirection

getFlipAngle

public double getFlipAngle()
Gets the value of the flipAngle property.

setFlipAngle

public void setFlipAngle(double value)
Sets the value of the flipAngle property.

isTypeSetting

public boolean isTypeSetting()
Gets the value of the typeSetting property.

setTypeSetting

public void setTypeSetting(boolean value)
Sets the value of the typeSetting property.

getTextPathClass

public String getTextPathClass()
Path of text baseline. Gets the value of the textPathClass property.

Returns:
possible object is String

setTextPathClass

public void setTextPathClass(String value)
Path of text baseline. Sets the value of the textPathClass property.

Parameters:
value - allowed object is String

getFillSymbol

public Symbol getFillSymbol()
Gets the value of the fillSymbol property.

Returns:
possible object is Symbol

setFillSymbol

public void setFillSymbol(Symbol value)
Sets the value of the fillSymbol property.

Parameters:
value - allowed object is Symbol

getText

public String getText()
Text to draw. Gets the value of the text property.

Returns:
possible object is String

setText

public void setText(String value)
Text to draw. Sets the value of the text property.

Parameters:
value - allowed object is String

getSize

public double getSize()
Text size. Gets the value of the size property.

setSize

public void setSize(double value)
Text size. Sets the value of the size property.

getMaskStyle

public EsriMaskStyle getMaskStyle()
Gets the value of the maskStyle property.

Returns:
possible object is EsriMaskStyle

setMaskStyle

public void setMaskStyle(EsriMaskStyle value)
Sets the value of the maskStyle property.

Parameters:
value - allowed object is EsriMaskStyle

getMaskSize

public double getMaskSize()
Gets the value of the maskSize property.

setMaskSize

public void setMaskSize(double value)
Sets the value of the maskSize property.

getMaskSymbol

public Symbol getMaskSymbol()
Gets the value of the maskSymbol property.

Returns:
possible object is Symbol

setMaskSymbol

public void setMaskSymbol(Symbol value)
Sets the value of the maskSymbol property.

Parameters:
value - allowed object is Symbol

getFontName

public String getFontName()
The name of the font family. Gets the value of the fontName property.

Returns:
possible object is String

setFontName

public void setFontName(String value)
The name of the font family. Sets the value of the fontName property.

Parameters:
value - allowed object is String

getFontItalic

public Boolean getFontItalic()
Indicates whether the font is italicized. Gets the value of the fontItalic property.

Returns:
possible object is Boolean

isFontItalic

public Boolean isFontItalic()
Indicates whether the font is italicized.

setFontItalic

public void setFontItalic(Boolean value)
Indicates whether the font is italicized. Sets the value of the fontItalic property.

Parameters:
value - allowed object is Boolean

getFontUnderline

public Boolean getFontUnderline()
Indicates whether the font is underlined. Gets the value of the fontUnderline property.

Returns:
possible object is Boolean

isFontUnderline

public Boolean isFontUnderline()
Indicates whether the font is underlined.

setFontUnderline

public void setFontUnderline(Boolean value)
Indicates whether the font is underlined. Sets the value of the fontUnderline property.

Parameters:
value - allowed object is Boolean

getFontStrikethrough

public Boolean getFontStrikethrough()
Indicates whether the font is strikethrough. Gets the value of the fontStrikethrough property.

Returns:
possible object is Boolean

isFontStrikethrough

public Boolean isFontStrikethrough()
Indicates whether the font is strikethrough.

setFontStrikethrough

public void setFontStrikethrough(Boolean value)
Indicates whether the font is strikethrough. Sets the value of the fontStrikethrough property.

Parameters:
value - allowed object is Boolean

getFontWeight

public Integer getFontWeight()
The boldness or weight of the font. Gets the value of the fontWeight property.

Returns:
possible object is Integer

setFontWeight

public void setFontWeight(Integer value)
The boldness or weight of the font. Sets the value of the fontWeight property.

Parameters:
value - allowed object is Integer

getFontCharset

public Integer getFontCharset()
The character set used in the font, such as ANSI_CHARSET, DEFAULT_CHARSET, or SYMBOL_CHARSET. Gets the value of the fontCharset property.

Returns:
possible object is Integer

setFontCharset

public void setFontCharset(Integer value)
Sets the value of the fontCharset property.

Parameters:
value - allowed object is Integer

getFontSizeHi

public Integer getFontSizeHi()
Point size of the font expressed in a 64-bit CY variable whose upper 32-bits contains the integer point size. Gets the value of the fontSizeHi property.

Returns:
possible object is Integer

setFontSizeHi

public void setFontSizeHi(Integer value)
Point size of the font expressed in a 64-bit CY variable whose upper 32-bits contains the integer point size. Sets the value of the fontSizeHi property.

Parameters:
value - allowed object is Integer

getFontSizeLo

public Integer getFontSizeLo()
Point size of the font expressed in a 64-bit CY variable whose lower 32-bits contains the fractional point size. Gets the value of the fontSizeLo property.

Returns:
possible object is Integer

setFontSizeLo

public void setFontSizeLo(Integer value)
Point size of the font expressed in a 64-bit CY variable whose lower 32-bits contains the fractional point size. Sets the value of the fontSizeLo property.

Parameters:
value - allowed object is Integer

getTextParserClass

public String getTextParserClass()
Text Parser Class ID Gets the value of the textParserClass property.

Returns:
possible object is String

setTextParserClass

public void setTextParserClass(String value)
Text Parser Class ID Sets the value of the textParserClass property.

Parameters:
value - allowed object is String
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD