Game Control Plus  1.2.2
 All Classes Namespaces Functions Variables Pages
org.gamecontrolplus.gui.MTextBase Class Reference
Inheritance diagram for org.gamecontrolplus.gui.MTextBase:

Public Member Functions

 MTextBase (PApplet theApplet, float p0, float p1, float p2, float p3)
 
void setText (String text)
 
boolean loadText (String fname)
 
boolean saveText (String fname)
 
void setFont (Font font)
 
void setStyledText (MStyledString ss)
 
void setTextPlain ()
 
void setTextBold (int start, int end)
 
void setTextBold ()
 
void setTextItalic (int start, int end)
 
void setTextItalic ()
 
MStyledString getStyledText ()
 
String getText ()
 
- Public Member Functions inherited from org.gamecontrolplus.gui.MAbstractControl
 MAbstractControl (PApplet theApplet)
 
 MAbstractControl (PApplet theApplet, float p0, float p1, float p2, float p3)
 
void draw ()
 
void mouseEvent (MouseEvent event)
 
void keyEvent (KeyEvent e)
 
void pre ()
 
void post ()
 
void dispose ()
 
void forceBufferUpdate ()
 
boolean isOver (float x, float y)
 
void setLocalColorScheme (int cs)
 
void setLocalColorScheme (int cs, boolean includeChildren)
 
int getLocalColorScheme ()
 
void setAlpha (int alpha)
 
void setAlpha (int alpha, boolean includeChildren)
 
MAbstractControl getParent ()
 
PApplet getPApplet ()
 
PGraphics getSnapshot ()
 
void addEventHandler (Object obj, String methodName)
 
void moveTo (float px, float py)
 
float getX ()
 
float getY ()
 
float getCX ()
 
float getCY ()
 
float getWidth ()
 
float getHeight ()
 
void setVisible (boolean visible)
 
boolean isVisible ()
 
void setOpaque (boolean opaque)
 
boolean isOpaque ()
 
boolean isDragging ()
 
void setEnabled (boolean enable)
 
boolean isEnabled ()
 
void setFocus (boolean focus)
 
boolean hasFocus ()
 
void addControl (MAbstractControl c, float x, float y, float angle)
 
void addControl (MAbstractControl c, float x, float y)
 
void addControl (MAbstractControl c)
 
void addControls (MAbstractControl...controls)
 
int getCursorOver ()
 
void setCursorOver (int cursorOver)
 
void markForDisposal ()
 
String toString ()
 

Public Attributes

MStyledString stext = new MStyledString("")
 
- Public Attributes inherited from org.gamecontrolplus.gui.MAbstractControl
String tag
 
int tagNo
 
- Public Attributes inherited from org.gamecontrolplus.gui.MConstants
int RED_SCHEME = 0
 
int GREEN_SCHEME = 1
 
int YELLOW_SCHEME = 2
 
int PURPLE_SCHEME = 3
 
int ORANGE_SCHEME = 4
 
int CYAN_SCHEME = 5
 
int BLUE_SCHEME = 6
 
int GOLD_SCHEME = 7
 
int SCHEME_8 = 8
 
int SCHEME_9 = 9
 
int SCHEME_10 = 10
 
int SCHEME_11 = 11
 
int SCHEME_12 = 12
 
int SCHEME_13 = 13
 
int SCHEME_14 = 14
 
int SCHEME_15 = 15
 
char HOME = java.awt.event.KeyEvent.VK_HOME
 
char END = java.awt.event.KeyEvent.VK_END
 
int CTRL_ANGULAR = 0x00000501
 
int CTRL_HORIZONTAL = 0x00000502
 
int CTRL_VERTICAL = 0x00000503
 
int EXIT_APP = 0x00000f01
 
int CLOSE_WINDOW = 0x00000f02
 
int KEEP_OPEN = 0x00000f03
 
int USER_COL_SCHEME = 0x00010102
 
int ALPHA_BLOCK = 128
 
int ALPHA_PICK = 48
 
int SCROLLBARS_NONE = 0x0000
 
int SCROLLBARS_VERTICAL_ONLY = 0x0001
 
int SCROLLBARS_HORIZONTAL_ONLY = 0x0002
 
int SCROLLBARS_BOTH = 0x0003
 
int SCROLLBARS_AUTOHIDE = 0x1000
 
int SCROLLBAR_VERTICAL = 1
 
int SCROLLBAR_HORIZONTAL = 2
 
int INTEGER = 0
 
int DECIMAL = 1
 
int EXPONENT = 2
 
int ORIENT_LEFT = -1
 
int ORIENT_TRACK = 0
 
int ORIENT_RIGHT = 1
 
int X4 = 1
 
int X8 = 2
 
int PLAIN = JOptionPane.PLAIN_MESSAGE
 
int ERROR = JOptionPane.ERROR_MESSAGE
 
int INFO = JOptionPane.INFORMATION_MESSAGE
 
int WARNING = JOptionPane.WARNING_MESSAGE
 
int QUERY = JOptionPane.QUESTION_MESSAGE
 
int YES_NO = JOptionPane.YES_NO_OPTION
 
int YES_NO_CANCEL = JOptionPane.YES_NO_CANCEL_OPTION
 
int OK_CANCEL = JOptionPane.OK_CANCEL_OPTION
 
int OK = JOptionPane.OK_OPTION
 
int YES = JOptionPane.YES_OPTION
 
int NO = JOptionPane.NO_OPTION
 
int CANCEL = JOptionPane.CANCEL_OPTION
 
int CLOSED = JOptionPane.CLOSED_OPTION
 
TextAttribute FAMILY = TextAttribute.FAMILY
 
TextAttribute WEIGHT = TextAttribute.WEIGHT
 
Float WEIGHT_EXTRA_LIGHT = new Float(0.5f)
 
Float WEIGHT_LIGHT = new Float(0.75f)
 
Float WEIGHT_DEMILIGHT = new Float(0.875f)
 
Float WEIGHT_REGULAR = new Float(1.0f)
 
Float WEIGHT_SEMIBOLD = new Float(1.25f)
 
Float WEIGHT_MEDIUM = new Float(1.5f)
 
Float WEIGHT_DEMIBOLD = new Float(1.75f)
 
Float WEIGHT_BOLD = new Float(2.0f)
 
Float WEIGHT_HEAVY = new Float(2.25f)
 
Float WEIGHT_EXTRABOLD = new Float(2.5f)
 
Float WEIGHT_ULTRABOLD = new Float(2.75f)
 
TextAttribute WIDTH = TextAttribute.WIDTH
 
Float WIDTH_CONDENSED = new Float(0.75f)
 
Float WIDTH_SEMI_CONDENSED = new Float(0.875f)
 
Float WIDTH_REGULAR = new Float(1.0f)
 
Float WIDTH_SEMI_EXTENDED = new Float(1.25f)
 
Float WIDTH_EXTENDED = new Float(1.5f)
 
TextAttribute POSTURE = TextAttribute.POSTURE
 
Float POSTURE_REGULAR = new Float(0.0f)
 
Float POSTURE_OBLIQUE = new Float(0.20f)
 
TextAttribute SIZE = TextAttribute.SIZE
 
TextAttribute SUPERSCRIPT = TextAttribute.SUPERSCRIPT
 
Integer SUPERSCRIPT_SUPER = new Integer(1)
 
Integer SUPERSCRIPT_SUB = new Integer(-1)
 
Integer SUPERSCRIPT_OFF = new Integer(0)
 
TextAttribute FOREGROUND = TextAttribute.FOREGROUND
 
TextAttribute BACKGROUND = TextAttribute.BACKGROUND
 
TextAttribute STRIKETHROUGH = TextAttribute.STRIKETHROUGH
 
Boolean STRIKETHROUGH_ON = new Boolean(true)
 
Boolean STRIKETHROUGH_OFF = new Boolean(false)
 
- Public Attributes inherited from org.gamecontrolplus.gui.MConstantsInternal
String SLIDER_STYLES = "|grey_blue|blue18px|green_red20px|purple18px|red_yellow18px|"
 
String DEFAULT_SLIDER_STYLE = "grey_blue"
 
int DRAW_METHOD = 0x00000001
 
int MOUSE_METHOD = 0x00000002
 
int PRE_METHOD = 0x00000004
 
int KEY_METHOD = 0x00000008
 
int POST_METHOD = 0x00000010
 
int ALL_METHOD = 0x0000001f
 
int RUNTIME_ERROR = 0xf0000000
 
int MISSING = 0x01000001
 
int NONEXISTANT = 0x01000002
 
int EXCP_IN_HANDLER = 0x81000003
 
int OFF_CONTROL = 0
 
int OVER_CONTROL = 1
 
int PRESS_CONTROL = 2
 
int DRAG_CONTROL = 3
 
int TINT_FOR_ALPHA = 255
 
int I_NONE = 0
 
int I_TL = 1
 
int I_TR = 2
 
int I_CL = 4
 
int I_CR = 8
 
int I_INSIDE = 16
 
int I_COVERED = 32
 
int I_MODES = 63
 
int MERGE_RUNS = 256
 
int CLIP_RUN = 512
 
int COMBI_MODES = 768
 
int[][] grid
 
BasicStroke pen_1_0 = new BasicStroke(1, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_2_0 = new BasicStroke(2, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_3_0 = new BasicStroke(3, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_4_0 = new BasicStroke(4, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 

Protected Member Functions

void addAttributeImpl (TextAttribute style, Object value)
 
void addAttributeImpl (TextAttribute style, Object value, int s, int e)
 
- Protected Member Functions inherited from org.gamecontrolplus.gui.MAbstractControl
void resize (float w, float h)
 
int whichHotSpot (float px, float py)
 
int getCurrHotSpot ()
 
PGraphics getBuffer ()
 
void updateBuffer ()
 
void createEventHandler (Object handlerObj, String methodName, Class[] param_classes, String[] param_names)
 
void fireEvent (Object...objects)
 
void setAvailable (boolean avail)
 
boolean isAvailable ()
 
void takeFocus ()
 
void loseFocus (MAbstractControl grabber)
 
void addToParent (MAbstractControl p)
 
AffineTransform getTransform (AffineTransform aff)
 
void calcTransformedOrigin (float px, float py)
 
void setZ (int parentZ)
 

Protected Attributes

Font localFont = M4P.globalFont
 
- Protected Attributes inherited from org.gamecontrolplus.gui.MAbstractControl
PApplet winApp
 
int z = Z_STICKY
 
boolean dragging = false
 
MAbstractControl parent = null
 
LinkedList< MAbstractControlchildren = null
 
int localColorScheme = M4P.globalColorScheme
 
int[] palette = null
 
Color[] jpalette = null
 
int alphaLevel = M4P.globalAlpha
 
float x
 
float width
 
float halfWidth
 
float cx
 
float rotAngle
 
double[] temp = new double[2]
 
PGraphicsJava2D buffer = null
 
boolean bufferInvalid = true
 
boolean opaque = false
 
int cursorOver = HAND
 
float ox
 
Object eventHandlerObject = null
 
Method eventHandlerMethod = null
 
String eventHandlerMethodName
 
MHotSpot[] hotspots = null
 
int currSpot = -1
 

Static Protected Attributes

static final int TPAD = 2
 
static final int TPAD2 = TPAD * 2
 
static final int TPAD4 = TPAD * 4
 
- Static Protected Attributes inherited from org.gamecontrolplus.gui.MAbstractControl
static float epsilon = 0.001f
 

Additional Inherited Members

- Static Protected Member Functions inherited from org.gamecontrolplus.gui.MAbstractControl
static int focusObjectZ ()
 
- Package Attributes inherited from org.gamecontrolplus.gui.MAbstractControl
float y
 
float height
 
float halfHeight
 
float cy
 
float oy
 
boolean visible = true
 
boolean enabled = true
 
boolean available = true
 
int registeredMethods = 0
 
- Static Package Attributes inherited from org.gamecontrolplus.gui.MAbstractControl
static MAbstractControl focusIsWith = null
 
static MAbstractControl controlToTakeFocus = null
 
static MAbstractControl cursorIsOver
 
static final int Z_PANEL = 1024
 
static final int Z_STICKY = 0
 
static final int Z_SLIPPY = 24
 

Detailed Description

Base class for any control that uses styled text.

Author
Peter Lager

Constructor & Destructor Documentation

org.gamecontrolplus.gui.MTextBase.MTextBase ( PApplet  theApplet,
float  p0,
float  p1,
float  p2,
float  p3 
)

Constructor

Parameters
theApplet
p0
p1
p2
p3

Member Function Documentation

void org.gamecontrolplus.gui.MTextBase.addAttributeImpl ( TextAttribute  style,
Object  value 
)
protected

Apply the style to the whole text

Parameters
stylethe style attribute
value'amount' to apply
void org.gamecontrolplus.gui.MTextBase.addAttributeImpl ( TextAttribute  style,
Object  value,
int  s,
int  e 
)
protected

Apply the style to a portion of the strin

Parameters
stylethe style attribute
value'amount' to apply
sfirst character to be included for styling
ethe first character not to be included for stylin
MStyledString org.gamecontrolplus.gui.MTextBase.getStyledText ( )

Get the text used for this control.

Returns
the displayed text without styling
String org.gamecontrolplus.gui.MTextBase.getText ( )

Get the text used for this control.

Returns
the displayed text without styling
boolean org.gamecontrolplus.gui.MTextBase.loadText ( String  fname)

Load the styled string to be used by this control.

Parameters
fnamethe name of the file to use
Returns
true if loaded successfully else false
boolean org.gamecontrolplus.gui.MTextBase.saveText ( String  fname)

Save the styled text used by this control to file.

Parameters
fnamethe name of the file to use
Returns
true if saved successfully else false
void org.gamecontrolplus.gui.MTextBase.setFont ( Font  font)

Set the font to be used in this control

Parameters
fontAWT font to use
void org.gamecontrolplus.gui.MTextBase.setStyledText ( MStyledString  ss)

Allows the user to provide their own styled text for this component

Parameters
ss
void org.gamecontrolplus.gui.MTextBase.setText ( String  text)

Set the text to be displayed.

Parameters
text
void org.gamecontrolplus.gui.MTextBase.setTextBold ( int  start,
int  end 
)

Make the selected characters bold.
Characters affected are >= start and < end

Parameters
startthe first character to style
endthe first character not to style
void org.gamecontrolplus.gui.MTextBase.setTextBold ( )

Make all the characters bold.

void org.gamecontrolplus.gui.MTextBase.setTextItalic ( int  start,
int  end 
)

Make the selected characters italic.
Characters affected are >= start and < end

Parameters
startthe first character to style
endthe first character not to style
void org.gamecontrolplus.gui.MTextBase.setTextItalic ( )

Make all the characters italic.

void org.gamecontrolplus.gui.MTextBase.setTextPlain ( )

Clear all applied styles from the whole text.

Member Data Documentation

MStyledString org.gamecontrolplus.gui.MTextBase.stext = new MStyledString("")

The styled text used by this control