CharAtom

java.lang.Object

org.scilab.forge.jlatexmath.Atom

org.scilab.forge.jlatexmath.CharSymbol

org.scilab.forge.jlatexmath.CharAtom

All Implemented Interfaces:: Cloneable

public class CharAtom extends CharSymbol

An atom representing exactly one alphanumeric character and the text style in which it should be drawn.

Field Summary

Fields inherited from class Atom
alignment, type, type_limits
Constructor Summary

Constructors

Constructor

Description

CharAtom(char c, String textStyle)

Creates a CharAtom that will represent the given character in the given text style.
Method Summary

Modifier and Type

Method

Description

Box

createBox(TeXEnvironment env)

Convert this atom into a Box, using properties set by "parent" atoms, like the TeX style, the last used font, color settings, ...

char

getCharacter()

CharFont

getCharFont(TeXFont tf)

Get the CharFont-object that uniquely identifies the character that is represented by this atom.

String

toString()

Methods inherited from class CharSymbol
isMarkedAsTextSymbol, markAsTextSymbol, removeMark

Methods inherited from class Atom
clone, getLeftType, getRightType

Methods inherited from class Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- CharAtom
  
  public CharAtom(char c, String textStyle)
  
  Creates a CharAtom that will represent the given character in the given text style. Null for the text style means the default text style.
  
  Parameters:
  
  c - the alphanumeric character
  
  textStyle - the text style in which the character should be drawn
Method Details
- createBox
  
  public Box createBox(TeXEnvironment env)
  
  Description copied from class: Atom
  
  Convert this atom into a Box, using properties set by "parent" atoms, like the TeX style, the last used font, color settings, ...
  
  Specified by:
  
  createBox in class Atom
  
  Parameters:
  
  env - the current environment settings
  
  Returns:
  
  the resulting box.
- getCharacter
  
  public char getCharacter()
- getCharFont
  
  public CharFont getCharFont(TeXFont tf)
  
  Description copied from class: CharSymbol
  
  Get the CharFont-object that uniquely identifies the character that is represented by this atom.
  
  Specified by:
  
  getCharFont in class CharSymbol
  
  Parameters:
  
  tf - the TeXFont containing all font related information
  
  Returns:
  
  a CharFont
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object