|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<MathGenLatex.LaSymbol>
cox.jmatt.java.MathTools.markup.latex.MathGenLatex.LaSymbol
public static enum MathGenLatex.LaSymbol
This enum
holds some of the (millions of) LaTeX symbols and commands used with mathematics. PLEASE NOTE: This list is not by
any means complete or comprehensive! It will also grow with time. The symbols represented here should be available with a base LaTeX package and not require
any external packages to be included. If a symbol does require an external package this will be noted in its description.
Some of the symbols are standalone, others allow parameters. Where needed the parameters are given through the format()
methods. The order
of the parameters is as they appear from left to right unless specified otherwise.
Binary relations and operations accept zero, one or two parameters. The first appears on the left of the symbol, the second on the right. The parameters are enclosed within curly braces to allow compound expressions if needed. This should not affect the output.
Font effect tags are named for the effect and NOT after the tag; e.g. 'ITALIC' is the '/textit...' tag. For font size effects the enum
consants
all begin with 'FS'. Note the 'large' tags differentiate between themselves by the number of 'L' characters in 'LARGE'.
Grouping symbol constructs all begin with GS and include the '/left' and '/right' directives in front of the specified variable-sized delimiters. All of these constructs take one parameter which is the markup to be included between the opening and closing symbols. This also includes (without the 'GS') certain 'wide' accents, such as the vector symbol, left arrow and tilde. Although these are not grouping symbols per se they can include groups of characters therefore they are classified as such.
Enum Constant Summary | |
---|---|
ALLIN
For all {} in {}, 2 params. |
|
APPROX
Binary relation: approximates (wavy equals). |
|
BOLD
Bold text, 1 param. |
|
BOWTIE
Binary relation: bowtie. |
|
CDOT
Binary operation: center-dot multiply. |
|
CIRC
Binary operation: circle-times. |
|
CONG
Binary relation: congruent. |
|
DIV
Binary operation: divide by. |
|
EQUIV
Binary relation: equivalent (tribar equals) |
|
FRAC
Fraction symbol, 2 params. |
|
FSFOOTNOTE
Font size 'footnote', 1 param. |
|
FSHUGE
Font size 'huge', 1 param. |
|
FSLARGE
Font size 'large', 1 param, spelling: 'L'. |
|
FSLLARGE
Font size 'Large', 1 param, spelling: 'LL'. |
|
FSLLLARGE
Font size 'LARGE', 1 param, spelling: 'LLL'. |
|
FSNORMAL
Font size 'normal', 1 param. |
|
FSSCRIPT
Font size 'scritpsize', 1 param. |
|
FSSMALL
Font size 'small', 1 param. |
|
FSTINY
Font size 'tiny', 1 param. |
|
GEQ
Binary relation: greater or equal. |
|
GSANGLE
Grouping symbol: angle brackets. |
|
GSCURLY
Grouping symbol: curly braces. |
|
GSGROUP
Grouping symbol: /lgroup and /rgroup. |
|
GSPAREN
Grouping symbol: parentheses. |
|
GSSQUARE
Grouping symbol: square brackets. |
|
INT
Single integral symbol, 0 to 3 params. |
|
ITALIC
Italicized text, 1 param. |
|
LATEX
This is the sequence for the LaTeX logo. |
|
LEQ
Binary relation: less or equal. |
|
MONOSPACE
Monospaced (teletype) text, 1 param. |
|
NEQ
Binary relation: not equal to. |
|
NOTEXIST
This is the 'not exist' symbol (slashed, backward 'E'), 0 params. |
|
NOTIN
This is the '/notin' symbol, 0 params. |
|
OLARROW
Overline left arrow, 1 param. |
|
ORARROW
Overline right arrow, 1 param. |
|
OVERLINE
Overlined text, 1 param. |
|
PARALLEL
Binary relation: parallel. |
|
PERP
Binary relation: perpendicular. |
|
PROD
Product symbol (uppercase pi), 0 to 3 params. |
|
SIM
Binary relation: similar. |
|
SIMEQ
Binary relation: similar or equal. |
|
SLANT
Slanted text, 1 param. |
|
SMALLCAP
Small caps, 1 param. |
|
SQRT
Radical symbol, 1 or 2 params. |
|
SUBSET
Binary relation: subset. |
|
SUBSETEQ
Binary relation: subset or equals. |
|
SUM
Summation symbol (uppercase sigma), 0 to 3 params. |
|
SUPSET
Binary relation: superset. |
|
SUPSETEQ
Binary relation: superset or equal. |
|
TIMES
Binary operation: multiplication symbol. |
|
UNDERLINE
Underlined text, 1 param. |
Method Summary | |
---|---|
java.lang.String |
format()
Calls format(null) . |
java.lang.String |
format(java.lang.String... pParams)
Return a symbol or command with all required parameters filled in. |
java.lang.String |
getFormat()
Return this symbol's raw formatting template. |
int |
getParams()
Return the number of parameters this symbol requires. |
static MathGenLatex.LaSymbol |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static MathGenLatex.LaSymbol[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final MathGenLatex.LaSymbol NOTEXIST
public static final MathGenLatex.LaSymbol NOTIN
public static final MathGenLatex.LaSymbol LATEX
public static final MathGenLatex.LaSymbol FRAC
public static final MathGenLatex.LaSymbol SQRT
public static final MathGenLatex.LaSymbol SUM
public static final MathGenLatex.LaSymbol PROD
public static final MathGenLatex.LaSymbol INT
public static final MathGenLatex.LaSymbol APPROX
public static final MathGenLatex.LaSymbol BOWTIE
public static final MathGenLatex.LaSymbol CONG
public static final MathGenLatex.LaSymbol EQUIV
public static final MathGenLatex.LaSymbol NEQ
public static final MathGenLatex.LaSymbol GEQ
public static final MathGenLatex.LaSymbol LEQ
public static final MathGenLatex.LaSymbol PARALLEL
public static final MathGenLatex.LaSymbol PERP
public static final MathGenLatex.LaSymbol SIM
public static final MathGenLatex.LaSymbol SIMEQ
public static final MathGenLatex.LaSymbol SUBSET
public static final MathGenLatex.LaSymbol SUBSETEQ
public static final MathGenLatex.LaSymbol SUPSET
public static final MathGenLatex.LaSymbol SUPSETEQ
public static final MathGenLatex.LaSymbol DIV
public static final MathGenLatex.LaSymbol CIRC
public static final MathGenLatex.LaSymbol CDOT
public static final MathGenLatex.LaSymbol TIMES
public static final MathGenLatex.LaSymbol ITALIC
public static final MathGenLatex.LaSymbol BOLD
public static final MathGenLatex.LaSymbol SLANT
public static final MathGenLatex.LaSymbol SMALLCAP
public static final MathGenLatex.LaSymbol MONOSPACE
public static final MathGenLatex.LaSymbol UNDERLINE
public static final MathGenLatex.LaSymbol OVERLINE
public static final MathGenLatex.LaSymbol FSTINY
public static final MathGenLatex.LaSymbol FSSCRIPT
public static final MathGenLatex.LaSymbol FSFOOTNOTE
public static final MathGenLatex.LaSymbol FSSMALL
public static final MathGenLatex.LaSymbol FSNORMAL
public static final MathGenLatex.LaSymbol FSLARGE
public static final MathGenLatex.LaSymbol FSLLARGE
public static final MathGenLatex.LaSymbol FSLLLARGE
public static final MathGenLatex.LaSymbol FSHUGE
public static final MathGenLatex.LaSymbol GSCURLY
public static final MathGenLatex.LaSymbol GSPAREN
public static final MathGenLatex.LaSymbol GSSQUARE
public static final MathGenLatex.LaSymbol GSANGLE
public static final MathGenLatex.LaSymbol GSGROUP
public static final MathGenLatex.LaSymbol ORARROW
public static final MathGenLatex.LaSymbol OLARROW
public static final MathGenLatex.LaSymbol ALLIN
Method Detail |
---|
public static MathGenLatex.LaSymbol[] values()
for (MathGenLatex.LaSymbol c : MathGenLatex.LaSymbol.values()) System.out.println(c);
public static MathGenLatex.LaSymbol valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic int getParams()
public java.lang.String getFormat()
public java.lang.String format(java.lang.String... pParams)
public java.lang.String format()
format(null)
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |