CharSymbol

java.lang.Object

org.scilab.forge.jlatexmath.Atom

org.scilab.forge.jlatexmath.CharSymbol

All Implemented Interfaces:: Cloneable

Direct Known Subclasses:: CharAtom, FixedCharAtom, SymbolAtom

public abstract class CharSymbol extends Atom

An common superclass for atoms that represent one single character and access the font information.

Field Summary

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

Constructors

Constructor

Description

CharSymbol()
Method Summary

Modifier and Type

Method

Description

abstract CharFont

getCharFont(TeXFont tf)

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

boolean

isMarkedAsTextSymbol()

Tests if this atom is marked as a text symbol (used by Msubsup)

void

markAsTextSymbol()

Mark as text symbol (used by Dummy)

void

removeMark()

Remove the mark so the atom remains unchanged (used by Dummy)

Methods inherited from class Atom
clone, createBox, getLeftType, getRightType

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

Constructor Details
- CharSymbol
  
  public CharSymbol()
Method Details
- markAsTextSymbol
  
  public void markAsTextSymbol()
  
  Mark as text symbol (used by Dummy)
- removeMark
  
  public void removeMark()
  
  Remove the mark so the atom remains unchanged (used by Dummy)
- isMarkedAsTextSymbol
  
  public boolean isMarkedAsTextSymbol()
  
  Tests if this atom is marked as a text symbol (used by Msubsup)
  
  Returns:
  
  whether this CharSymbol is marked as a text symbol
- getCharFont
  
  public abstract CharFont getCharFont(TeXFont tf)
  
  Get the CharFont-object that uniquely identifies the character that is represented by this atom.
  
  Parameters:
  
  tf - the TeXFont containing all font related information
  
  Returns:
  
  a CharFont