IlvMapTextStyle (Rogue Wave JViews 9.0 API)

java.lang.Object
- ilog.views.maps.graphic.style.IlvMapStyle
- - ilog.views.maps.graphic.style.IlvMapTextStyle

All Implemented Interfaces:

IlvPersistentObject, IlvInheritable
```
public class IlvMapTextStyle
extends IlvMapStyle
```
Class holding main graphic attributes for a text.

Since:

JViews 7.5

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALIGNMENT` The Alignment property name.
`static String`	`ANGLE` The Angle property name.
`static String`	`ANTIALIASING` The Antialiasing property name.
`static String`	`ATTACHMENT` The Attachment property name.
`static String`	`BACKGROUND_PAINT` The Background Paint property name.
`static String`	`BASE_TEXT_DIRECTION` The BaseTextDirection property name.
`static String`	`FILL_PAINT` The Fill Paint property name.
`static String`	`FITTORECT` The FitToRect property name.
`static String`	`FONT` The Font property name.
`static String`	`FOREGROUND` The Foreground property name.
`static String`	`FRAME_PAINT` The Frame Paint property name.
`static String`	`INNER_MARGIN` The Inner Margin property name.
`static String`	`INTERLINE` The Interline property name.
`static String`	`MAXIMUM_HEIGHT` The Maximum Height property name.
`static String`	`MAXIMUM_LINE_HEIGHT` The Maximum Line Height property name.
`static String`	`MINIMUM_HEIGHT` The Minimum Height property name.
`static String`	`STROKE_PAINT` The Stroke Paint property name.

Fields inherited from class ilog.views.maps.graphic.style.IlvMapStyle
ALPHA, ALWAYS_ON_TOP, ATTRIBUTE_INFO, CATEGORY, LABEL_ATTRIBUTE, LEGEND_GROUP, PARENT, THIN_CLIENT_BACKGROUND, VISIBLE_IN_3DVIEW, VISIBLE_IN_OVERVIEW, VISIBLE_IN_TREE, VISIBLE_IN_VIEW

Constructor Summary

Constructors
Constructor and Description
`IlvMapTextStyle()` Constructs a `IlvMapTextStyle`.
`IlvMapTextStyle(IlvInputStream stream)` Reads an `IlvMapTextStyle` from an `IlvInputStream`.
`IlvMapTextStyle(IlvMapTextStyle source)` Constructs an `IlvMapTextStyle` by copying an existing one.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IlvMapStyle`	`copy()` Returns a copy of this `IlvMapTextStyle`
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`getAlignment()` Retrieves the Alignment property value.
`double`	`getAngle()` Retrieves the Angle property value.
`int`	`getAttachment()` Retrieves the Attachment property value.
`Paint`	`getBackgroundPaint()` Retrieves the BackgroundPaint property value.
`int`	`getBaseTextDirection()` Retrieves the BaseTextDirection property value.
`Paint`	`getFillPaint()` Retrieves the FillPaint property value.
`Font`	`getFont()` Retrieves the Font property value.
`Color`	`getForeground()` Retrieve the `FOREGROUND` attribute value.
`Paint`	`getFramePaint()` Retrieves the FramePaint property value.
`double`	`getInnerMargin()` Retrieves the InnerMargin property value.
`double`	`getInterline()` Retrieves the Interline property value.
`int`	`getMaximumHeight()` Retrieves the MaximumHeight property value.
`int`	`getMaximumLineHeight()` Retrieves the MaximumLineHeight property value.
`int`	`getMinimumHeight()` Retrieves the MinimumHeight property value.
`Paint`	`getStrokePaint()` Retrieves the StrokePaint property value.
`int`	`hashCode()`
`boolean`	`isAntialiasing()` Retrieves the Antialiasing property value.
`boolean`	`isFitToRect()` Retrieves the FitToRect property value.
`void`	`setAlignment(int alignment)` Sets the Alignment property value.
`void`	`setAngle(double angle)` Sets the Angle property value.
`void`	`setAntialiasing(boolean antialiasing)` Sets the Antialiasing property value.
`void`	`setAttachment(int attachment)` Sets the Attachment property value.
`void`	`setBackgroundPaint(Paint backgroundPaint)` Sets the BackgroundPaint property value.
`void`	`setBaseTextDirection(int textDir)` Sets the base text direction.
`void`	`setFillPaint(Paint paint)` Sets the FillPaint property value.
`void`	`setFitToRect(boolean fit)` Sets the FitToRect property value.
`void`	`setFont(Font font)` Sets the Font property value.
`void`	`setForeground(Color c)` Sets the `FOREGROUND` attribute value.
`void`	`setFramePaint(Paint paint)` Sets the FramePaint property value.
`void`	`setInnerMargin(double margin)` Sets the InnerMargin property value.
`void`	`setInterline(double interline)` Sets the Interline property value.
`void`	`setMaximumHeight(int height)` Sets the MaximumHeight property value.
`void`	`setMaximumLineHeight(int height)` Sets the MaximumHeight property value.
`void`	`setMinimumHeight(int height)` Sets the MinimumHeight property value.
`void`	`setStrokePaint(Paint paint)` Sets the StrokePaint property value.
`void`	`write(IlvOutputStream stream)` Write a `IlvMapStyle` on a `IlvOutputStream`

Methods inherited from class ilog.views.maps.graphic.style.IlvMapStyle
addAttributeListener, addChild, addStyleListener, addWeakStyleListener, getAlpha, getAttribute, getAttribute, getAttributeFilter, getAttributeInfo, getAttributeListeners, getCategory, getChildren, getDefaultValues, getGraphic, getLabelAttribute, getLegendGroup, getListeners, getParent, getStyleListeners, isAlwaysOnTop, isInherited, isThinClientBackground, isVisibleIn3DView, isVisibleInOverview, isVisibleInTree, isVisibleInView, objectEquals, removeAttributeListener, removeChild, removeStyleListener, setAlpha, setAlwaysOnTop, setAttribute, setAttributeFilter, setAttributeInfo, setCategory, setGraphic, setInherited, setLabelAttribute, setLegendGroup, setParent, setThinClientBackground, setVisibleIn3DView, setVisibleInOverview, setVisibleInTree, setVisibleInView

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FOREGROUND
```
public static final String FOREGROUND
```
    The Foreground property name.
    
    See Also:
    
    Constant Field Values
  - ANTIALIASING
```
public static final String ANTIALIASING
```
    The Antialiasing property name.
    
    See Also:
    
    Constant Field Values
  - ATTACHMENT
```
public static final String ATTACHMENT
```
    The Attachment property name.
    
    See Also:
    
    Constant Field Values
  - FILL_PAINT
```
public static final String FILL_PAINT
```
    The Fill Paint property name.
    
    See Also:
    
    Constant Field Values
  - FONT
```
public static final String FONT
```
    The Font property name.
    
    See Also:
    
    Constant Field Values
  - FRAME_PAINT
```
public static final String FRAME_PAINT
```
    The Frame Paint property name.
    
    See Also:
    
    Constant Field Values
  - INNER_MARGIN
```
public static final String INNER_MARGIN
```
    The Inner Margin property name.
    
    See Also:
    
    Constant Field Values
  - INTERLINE
```
public static final String INTERLINE
```
    The Interline property name.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_HEIGHT
```
public static final String MAXIMUM_HEIGHT
```
    The Maximum Height property name.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_LINE_HEIGHT
```
public static final String MAXIMUM_LINE_HEIGHT
```
    The Maximum Line Height property name.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    Constant Field Values
  - MINIMUM_HEIGHT
```
public static final String MINIMUM_HEIGHT
```
    The Minimum Height property name.
    
    See Also:
    
    Constant Field Values
  - STROKE_PAINT
```
public static final String STROKE_PAINT
```
    The Stroke Paint property name.
    
    See Also:
    
    Constant Field Values
  - ANGLE
```
public static final String ANGLE
```
    The Angle property name.
    
    See Also:
    
    Constant Field Values
  - BACKGROUND_PAINT
```
public static final String BACKGROUND_PAINT
```
    The Background Paint property name.
    
    See Also:
    
    Constant Field Values
  - ALIGNMENT
```
public static final String ALIGNMENT
```
    The Alignment property name.
    
    See Also:
    
    Constant Field Values
  - FITTORECT
```
public static final String FITTORECT
```
    The FitToRect property name.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    Constant Field Values
  - BASE_TEXT_DIRECTION
```
public static final String BASE_TEXT_DIRECTION
```
    The BaseTextDirection property name.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvMapTextStyle
```
public IlvMapTextStyle()
```
    Constructs a IlvMapTextStyle.
  - IlvMapTextStyle
```
public IlvMapTextStyle(IlvInputStream stream)
                throws IlvReadFileException
```
    Reads an IlvMapTextStyle from an IlvInputStream.
    
    Parameters:
    
    stream - The stream to read from.
    
    Throws:
    
    IlvReadFileException
  - IlvMapTextStyle
```
public IlvMapTextStyle(IlvMapTextStyle source)
```
    Constructs an IlvMapTextStyle by copying an existing one.
    
    Parameters:
    
    source - The style to copy.
- Method Detail
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Write a IlvMapStyle on a IlvOutputStream
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Overrides:
    
    write in class IlvMapStyle
    
    Parameters:
    
    stream - The stream to write to.
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
    
    See Also:
    
    IlvMapStyle.write(ilog.views.io.IlvOutputStream)
  - copy
```
public IlvMapStyle copy()
```
    Returns a copy of this IlvMapTextStyle
    
    Overrides:
    
    copy in class IlvMapStyle
    
    Returns:
    
    A copy of the style.
    
    See Also:
    
    IlvMapStyle.copy()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class IlvMapStyle
  - equals
```
public boolean equals(Object o)
```
    Indicates whether some other object is "equal to" this one.
    
    Overrides:
    
    equals in class IlvMapStyle
    
    See Also:
    
    IlvMapStyle.equals(java.lang.Object)
  - getForeground
```
public Color getForeground()
```
    Retrieve the FOREGROUND attribute value.
    
    Returns:
    
    The FOREGROUND attribute value.
  - setForeground
```
public void setForeground(Color c)
```
    Sets the FOREGROUND attribute value.
    
    Parameters:
    
    c - The FOREGROUND attribute value as a Color
  - getAlignment
```
public int getAlignment()
```
    Retrieves the Alignment property value.
    
    Returns:
    
    The Alignment property value.
  - setAlignment
```
public void setAlignment(int alignment)
```
    Sets the Alignment property value.
    
    Parameters:
    
    alignment - The Alignment property value.
  - setFitToRect
```
public void setFitToRect(boolean fit)
```
    Sets the FitToRect property value.
    
    Parameters:
    
    fit - The FitToRect property value.
    
    Since:
    
    JViews 7.5
  - isFitToRect
```
public boolean isFitToRect()
```
    Retrieves the FitToRect property value.
    
    Returns:
    
    The FitToRect property value.
    
    Since:
    
    JViews 7.5
  - isAntialiasing
```
public boolean isAntialiasing()
```
    Retrieves the Antialiasing property value.
    
    Returns:
    
    The Antialiasing property value.
  - setAntialiasing
```
public void setAntialiasing(boolean antialiasing)
```
    Sets the Antialiasing property value.
    
    Parameters:
    
    antialiasing - The Antialiasing property value.
  - getAttachment
```
public int getAttachment()
```
    Retrieves the Attachment property value.
    
    Returns:
    
    The Attachment property value.
  - setAttachment
```
public void setAttachment(int attachment)
```
    Sets the Attachment property value.
    
    Parameters:
    
    attachment - The Attachment property value.
  - getFillPaint
```
public Paint getFillPaint()
```
    Retrieves the FillPaint property value.
    
    Returns:
    
    The FillPaint property value.
  - setFillPaint
```
public void setFillPaint(Paint paint)
```
    Sets the FillPaint property value.
    
    Parameters:
    
    paint - The FillPaint property value.
  - getFont
```
public Font getFont()
```
    Retrieves the Font property value.
    
    Returns:
    
    The Font property value.
  - setFont
```
public void setFont(Font font)
```
    Sets the Font property value.
    
    Parameters:
    
    font - The Font property value.
  - getFramePaint
```
public Paint getFramePaint()
```
    Retrieves the FramePaint property value.
    
    Returns:
    
    The FramePaint property value.
  - setFramePaint
```
public void setFramePaint(Paint paint)
```
    Sets the FramePaint property value.
    
    Parameters:
    
    paint - The FramePaint property value.
  - getInnerMargin
```
public double getInnerMargin()
```
    Retrieves the InnerMargin property value.
    
    Returns:
    
    The InnerMargin property value.
  - setInnerMargin
```
public void setInnerMargin(double margin)
```
    Sets the InnerMargin property value.
    
    Parameters:
    
    margin - The InnerMargin property value.
  - getInterline
```
public double getInterline()
```
    Retrieves the Interline property value.
    
    Returns:
    
    The Interline property value.
  - setInterline
```
public void setInterline(double interline)
```
    Sets the Interline property value.
    
    Parameters:
    
    interline - The Interline property value.
  - getMaximumHeight
```
public int getMaximumHeight()
```
    Retrieves the MaximumHeight property value.
    
    Returns:
    
    The MaximumHeight property value.
  - setMaximumHeight
```
public void setMaximumHeight(int height)
```
    Sets the MaximumHeight property value.
    
    Parameters:
    
    height - The MaximumHeight property value.
  - getMaximumLineHeight
```
public int getMaximumLineHeight()
```
    Retrieves the MaximumLineHeight property value.
    
    Returns:
    
    The MaximumLineHeight property value.
    
    Since:
    
    JViews 7.5
  - setMaximumLineHeight
```
public void setMaximumLineHeight(int height)
```
    Sets the MaximumHeight property value.
    
    Parameters:
    
    height - The MaximumHeight property value.
    
    Since:
    
    JViews 7.5
  - getMinimumHeight
```
public int getMinimumHeight()
```
    Retrieves the MinimumHeight property value.
    
    Returns:
    
    The MinimumHeight property value.
  - setMinimumHeight
```
public void setMinimumHeight(int height)
```
    Sets the MinimumHeight property value.
    
    Parameters:
    
    height - The MinimumHeight property value.
  - getStrokePaint
```
public Paint getStrokePaint()
```
    Retrieves the StrokePaint property value.
    
    Returns:
    
    The StrokePaint property value.
  - setStrokePaint
```
public void setStrokePaint(Paint paint)
```
    Sets the StrokePaint property value.
    
    Parameters:
    
    paint - The StrokePaint property value.
  - getAngle
```
public double getAngle()
```
    Retrieves the Angle property value.
    
    Returns:
    
    The Angle property value.
  - setAngle
```
public void setAngle(double angle)
```
    Sets the Angle property value.
    
    Parameters:
    
    angle - The Angle property value.
  - getBackgroundPaint
```
public Paint getBackgroundPaint()
```
    Retrieves the BackgroundPaint property value.
    
    Returns:
    
    The BackgroundPaint property value.
  - setBackgroundPaint
```
public void setBackgroundPaint(Paint backgroundPaint)
```
    Sets the BackgroundPaint property value.
    
    Parameters:
    
    backgroundPaint - The BackgroundPaint property value.
  - setBaseTextDirection
```
public void setBaseTextDirection(int textDir)
```
    Sets the base text direction.
    
    Parameters:
    
    textDir - New bas text direction
    
    Since:
    
    JViews 8.8
  - getBaseTextDirection
```
public int getBaseTextDirection()
```
    Retrieves the BaseTextDirection property value.
    
    Returns:
    
    The BaseTextDirection property value.
    
    Since:
    
    JViews 8.8

Class IlvMapTextStyle

Field Summary

Fields inherited from class ilog.views.maps.graphic.style.IlvMapStyle

Constructor Summary

Method Summary

Methods inherited from class ilog.views.maps.graphic.style.IlvMapStyle

Methods inherited from class java.lang.Object

Field Detail

FOREGROUND

ANTIALIASING

ATTACHMENT

FILL_PAINT

FONT

FRAME_PAINT

INNER_MARGIN

INTERLINE

MAXIMUM_HEIGHT

MAXIMUM_LINE_HEIGHT

MINIMUM_HEIGHT

STROKE_PAINT

ANGLE

BACKGROUND_PAINT

ALIGNMENT

FITTORECT

BASE_TEXT_DIRECTION

Constructor Detail

IlvMapTextStyle

IlvMapTextStyle

IlvMapTextStyle

Method Detail

write

copy

hashCode

equals

getForeground

setForeground

getAlignment

setAlignment

setFitToRect

isFitToRect

isAntialiasing

setAntialiasing

getAttachment

setAttachment

getFillPaint

setFillPaint

getFont

setFont

getFramePaint

setFramePaint

getInnerMargin

setInnerMargin

getInterline

setInterline

getMaximumHeight

setMaximumHeight

getMaximumLineHeight

setMaximumLineHeight

getMinimumHeight

setMinimumHeight

getStrokePaint

setStrokePaint

getAngle

setAngle

getBackgroundPaint

setBackgroundPaint

setBaseTextDirection

getBaseTextDirection