Java Scientific Calculator: jscicalc.pobject.PObject Class Reference

This class represents any token that can be parsed as input. More...

Collaboration diagram for jscicalc.pobject.PObject:

Collaboration graph

List of all members.

Public Member Functions
String	name ()
	The long version of the name.
String	shortName ()
	The short version of the name.
abstract String[]	name_array ()
	Array used to construct name() and shortName() String objects.
String	tooltip ()
	A tooltip.
char	shortcut ()
	A shortcut key character.
Protected Attributes
String	ftooltip
	The tooltip string.
char	fshortcut
	The shortcut key character.

Detailed Description

This class represents any token that can be parsed as input.

Since tokens are also represented as buttons on the calculator, there are different representations of the given by name() and short_name(). The functions tooltip() and shortcut() give a tooltip and shortcut key for this token/object/button.

This is one of the most important classes for the calculator because it encapsulates all the information needed for things you can put in an expression. It contains a name suitable for both CalculatorButton and for part of and Expression used in DisplayLabel. It also contains a shortcut key (used to record waht keys it should respond to) and a tooltip text for its CalculatorButton. Through a hierarchy of subclasses it also holds functions associated with it. For example, Plus is a PObject containing a functions that adds together two doubles.

See also:: Parser, GObject

Author:: J. D. Lamb

Version:

Revision:: 1.5

Member Function Documentation

String jscicalc.pobject.PObject.name ( )

The long version of the name.

Used for the display and CalculatorButton.

Returns:: long version of name.

Reimplemented in jscicalc.pobject.Numeral, and jscicalc.pobject.Variable.

References jscicalc.pobject.PObject.name_array().

Referenced by jscicalc.pobject.Xor.main(), jscicalc.pobject.Uplus.main(), jscicalc.pobject.Up.main(), jscicalc.pobject.Uminus.main(), jscicalc.pobject.TenX.main(), jscicalc.pobject.Tan.main(), jscicalc.pobject.Subtract.main(), jscicalc.pobject.STO.main(), jscicalc.pobject.StDev.main(), jscicalc.pobject.SquareRoot.main(), jscicalc.pobject.Square.main(), jscicalc.pobject.Sin.main(), jscicalc.pobject.SigmaPlus.main(), jscicalc.pobject.SigmaMinus.main(), jscicalc.pobject.Shift.main(), jscicalc.pobject.Scl.main(), jscicalc.pobject.Sci.main(), jscicalc.pobject.RParen.main(), jscicalc.pobject.Root.main(), jscicalc.pobject.Right.main(), jscicalc.pobject.RCL.main(), jscicalc.pobject.Power.main(), jscicalc.pobject.PopStDev.main(), jscicalc.pobject.Pol.main(), jscicalc.pobject.Pi.main(), jscicalc.pobject.Permutation.main(), jscicalc.pobject.Or.main(), jscicalc.pobject.On.main(), jscicalc.pobject.Off.main(), jscicalc.pobject.Oct.main(), jscicalc.pobject.Multiply.main(), jscicalc.pobject.Mplus.main(), jscicalc.pobject.Mode.main(), jscicalc.pobject.Mminus.main(), jscicalc.pobject.Mean.main(), jscicalc.pobject.Mcl.main(), jscicalc.pobject.LParen.main(), jscicalc.pobject.Log.main(), jscicalc.pobject.Ln.main(), jscicalc.pobject.Left.main(), jscicalc.pobject.Inverse.main(), jscicalc.pobject.Info.main(), jscicalc.pobject.I.main(), jscicalc.pobject.Hex.main(), jscicalc.pobject.Graph.main(), jscicalc.pobject.Factorial.main(), jscicalc.pobject.Exp.main(), jscicalc.pobject.Equals.main(), jscicalc.pobject.E.main(), jscicalc.pobject.Down.main(), jscicalc.pobject.Divide.main(), jscicalc.pobject.Del.main(), jscicalc.pobject.Dec.main(), jscicalc.pobject.CubeRoot.main(), jscicalc.pobject.Cube.main(), jscicalc.pobject.Cplx.main(), jscicalc.pobject.Cos.main(), jscicalc.pobject.Copy.main(), jscicalc.pobject.Conjugate.main(), jscicalc.pobject.Combination.main(), jscicalc.pobject.Bin.main(), jscicalc.pobject.ATan.main(), jscicalc.pobject.ASin.main(), jscicalc.pobject.Ans.main(), jscicalc.pobject.And.main(), jscicalc.pobject.Add.main(), and jscicalc.pobject.ACos.main().

abstract String [] jscicalc.pobject.PObject.name_array ( ) [pure virtual]

Array used to construct name() and shortName() String objects.

Returns:: an array

Implemented in jscicalc.pobject.ACos, jscicalc.pobject.Add, jscicalc.pobject.And, jscicalc.pobject.Ans, jscicalc.pobject.ASin, jscicalc.pobject.ATan, jscicalc.pobject.Bin, jscicalc.pobject.Combination, jscicalc.pobject.Conjugate, jscicalc.pobject.Copy, jscicalc.pobject.Cos, jscicalc.pobject.Cplx, jscicalc.pobject.Cube, jscicalc.pobject.CubeRoot, jscicalc.pobject.Dec, jscicalc.pobject.Del, jscicalc.pobject.Divide, jscicalc.pobject.Down, jscicalc.pobject.E, jscicalc.pobject.Equals, jscicalc.pobject.Exp, jscicalc.pobject.Factorial, jscicalc.pobject.Graph, jscicalc.pobject.Hex, jscicalc.pobject.I, jscicalc.pobject.Info, jscicalc.pobject.Inverse, jscicalc.pobject.Left, jscicalc.pobject.Ln, jscicalc.pobject.Log, jscicalc.pobject.LParen, jscicalc.pobject.Mcl, jscicalc.pobject.Mean, jscicalc.pobject.Mminus, jscicalc.pobject.Mode, jscicalc.pobject.Mplus, jscicalc.pobject.Multiply, jscicalc.pobject.NullPObject, jscicalc.pobject.Numeral, jscicalc.pobject.Oct, jscicalc.pobject.Off, jscicalc.pobject.On, jscicalc.pobject.Or, jscicalc.pobject.Permutation, jscicalc.pobject.Pi, jscicalc.pobject.Pol, jscicalc.pobject.PopStDev, jscicalc.pobject.Power, jscicalc.pobject.RCL, jscicalc.pobject.Right, jscicalc.pobject.Root, jscicalc.pobject.RParen, jscicalc.pobject.Sci, jscicalc.pobject.Scl, jscicalc.pobject.Shift, jscicalc.pobject.SigmaMinus, jscicalc.pobject.SigmaPlus, jscicalc.pobject.Sin, jscicalc.pobject.Square, jscicalc.pobject.SquareRoot, jscicalc.pobject.StDev, jscicalc.pobject.STO, jscicalc.pobject.Subtract, jscicalc.pobject.Tan, jscicalc.pobject.TenX, jscicalc.pobject.Uminus, jscicalc.pobject.Up, jscicalc.pobject.Uplus, jscicalc.pobject.Variable, and jscicalc.pobject.Xor.

Referenced by jscicalc.EntryLabel.delete(), jscicalc.Parser.getListAsStringVector(), jscicalc.Parser.getStringVector(), jscicalc.EntryLabel.insert(), jscicalc.pobject.PObject.name(), and jscicalc.pobject.PObject.shortName().

char jscicalc.pobject.PObject.shortcut ( )

A shortcut key character.

Returns:: a character representing a shortcut key

References jscicalc.pobject.PObject.fshortcut.

Referenced by jscicalc.button.CalculatorButton.actionPerformed(), jscicalc.button.BinButton.BinButton(), jscicalc.button.CplxButton.CplxButton(), jscicalc.button.DecButton.DecButton(), jscicalc.button.HexButton.HexButton(), jscicalc.button.InfoButton.InfoButton(), jscicalc.button.OctButton.OctButton(), jscicalc.button.PolButton.PolButton(), jscicalc.button.SciButton.SciButton(), and jscicalc.button.CalculatorButton.setPObject().

String jscicalc.pobject.PObject.shortName ( )

The short version of the name.

Used for the key.

Returns:: short version of name.

Reimplemented in jscicalc.pobject.Combination, jscicalc.pobject.Cube, jscicalc.pobject.Factorial, jscicalc.pobject.Inverse, jscicalc.pobject.Permutation, and jscicalc.pobject.Square.

References jscicalc.pobject.PObject.name_array().

Referenced by jscicalc.button.CalculatorButton.setText().

String jscicalc.pobject.PObject.tooltip ( )

A tooltip.

Returns:: a tooltip

References jscicalc.pobject.PObject.ftooltip.

Referenced by jscicalc.button.BinButton.BinButton(), jscicalc.button.CplxButton.CplxButton(), jscicalc.button.DecButton.DecButton(), jscicalc.button.DownButton.DownButton(), jscicalc.button.HexButton.HexButton(), jscicalc.button.InfoButton.InfoButton(), jscicalc.button.LeftButton.LeftButton(), jscicalc.button.OctButton.OctButton(), jscicalc.button.PolButton.PolButton(), jscicalc.button.RightButton.RightButton(), jscicalc.button.SciButton.SciButton(), jscicalc.button.CalculatorButton.setPObject(), and jscicalc.button.UpButton.UpButton().

Member Data Documentation

char jscicalc.pobject.PObject.fshortcut [protected]

The shortcut key character.

Referenced by jscicalc.pobject.ACos.ACos(), jscicalc.pobject.Add.Add(), jscicalc.pobject.And.And(), jscicalc.pobject.ASin.ASin(), jscicalc.pobject.ATan.ATan(), jscicalc.pobject.Bin.Bin(), jscicalc.pobject.Combination.Combination(), jscicalc.pobject.Conjugate.Conjugate(), jscicalc.pobject.Cos.Cos(), jscicalc.pobject.Cplx.Cplx(), jscicalc.pobject.Cube.Cube(), jscicalc.pobject.CubeRoot.CubeRoot(), jscicalc.pobject.Dec.Dec(), jscicalc.pobject.Divide.Divide(), jscicalc.pobject.Down.Down(), jscicalc.pobject.E.E(), jscicalc.pobject.Exp.Exp(), jscicalc.pobject.Factorial.Factorial(), jscicalc.pobject.Hex.Hex(), jscicalc.pobject.I.I(), jscicalc.pobject.Info.Info(), jscicalc.pobject.Inverse.Inverse(), jscicalc.pobject.Left.Left(), jscicalc.pobject.Ln.Ln(), jscicalc.pobject.Log.Log(), jscicalc.pobject.LParen.LParen(), jscicalc.pobject.Mean.Mean(), jscicalc.pobject.Multiply.Multiply(), jscicalc.pobject.NullPObject.NullPObject(), jscicalc.pobject.Numeral.Numeral(), jscicalc.pobject.Oct.Oct(), jscicalc.pobject.Or.Or(), jscicalc.pobject.Permutation.Permutation(), jscicalc.pobject.Pi.Pi(), jscicalc.pobject.Pol.Pol(), jscicalc.pobject.PopStDev.PopStDev(), jscicalc.pobject.Power.Power(), jscicalc.pobject.Right.Right(), jscicalc.pobject.Root.Root(), jscicalc.pobject.RParen.RParen(), jscicalc.pobject.Sci.Sci(), jscicalc.pobject.PObject.shortcut(), jscicalc.pobject.Sin.Sin(), jscicalc.pobject.Square.Square(), jscicalc.pobject.SquareRoot.SquareRoot(), jscicalc.pobject.StDev.StDev(), jscicalc.pobject.Subtract.Subtract(), jscicalc.pobject.Tan.Tan(), jscicalc.pobject.TenX.TenX(), jscicalc.pobject.Up.Up(), jscicalc.pobject.Variable.Variable(), and jscicalc.pobject.Xor.Xor().

String jscicalc.pobject.PObject.ftooltip [protected]

The tooltip string.

Referenced by jscicalc.pobject.ACos.ACos(), jscicalc.pobject.Add.Add(), jscicalc.pobject.And.And(), jscicalc.pobject.ASin.ASin(), jscicalc.pobject.ATan.ATan(), jscicalc.pobject.Bin.Bin(), jscicalc.pobject.Combination.Combination(), jscicalc.pobject.Conjugate.Conjugate(), jscicalc.pobject.Cos.Cos(), jscicalc.pobject.Cplx.Cplx(), jscicalc.pobject.Cube.Cube(), jscicalc.pobject.CubeRoot.CubeRoot(), jscicalc.pobject.Dec.Dec(), jscicalc.pobject.Divide.Divide(), jscicalc.pobject.Down.Down(), jscicalc.pobject.E.E(), jscicalc.pobject.Exp.Exp(), jscicalc.pobject.Factorial.Factorial(), jscicalc.pobject.Hex.Hex(), jscicalc.pobject.I.I(), jscicalc.pobject.Info.Info(), jscicalc.pobject.Inverse.Inverse(), jscicalc.pobject.Left.Left(), jscicalc.pobject.Ln.Ln(), jscicalc.pobject.Log.Log(), jscicalc.pobject.LParen.LParen(), jscicalc.pobject.Mean.Mean(), jscicalc.pobject.Multiply.Multiply(), jscicalc.pobject.NullPObject.NullPObject(), jscicalc.pobject.Numeral.Numeral(), jscicalc.pobject.Oct.Oct(), jscicalc.pobject.Or.Or(), jscicalc.pobject.Permutation.Permutation(), jscicalc.pobject.Pi.Pi(), jscicalc.pobject.Pol.Pol(), jscicalc.pobject.PopStDev.PopStDev(), jscicalc.pobject.Power.Power(), jscicalc.pobject.Right.Right(), jscicalc.pobject.Root.Root(), jscicalc.pobject.RParen.RParen(), jscicalc.pobject.Sci.Sci(), jscicalc.pobject.Sin.Sin(), jscicalc.pobject.Square.Square(), jscicalc.pobject.SquareRoot.SquareRoot(), jscicalc.pobject.StDev.StDev(), jscicalc.pobject.Subtract.Subtract(), jscicalc.pobject.Tan.Tan(), jscicalc.pobject.TenX.TenX(), jscicalc.pobject.PObject.tooltip(), jscicalc.pobject.Up.Up(), jscicalc.pobject.Variable.Variable(), and jscicalc.pobject.Xor.Xor().

The documentation for this class was generated from the following file:

PObject.java