ctext
index
Name CText
Examples
None available
Description Core text manipulation/storage object.
Constructors
CText(parent, image);
CText(parent, align);
CText(parent, text);
CText(parent, text, alignment);
CText(parent, character);
CText(parent, startXPos, startYPos);
CText(parent, text, startXPos, startYPos);
CText(parent, text, startXPos, startYPos, alignment);
Fields
font   Font for this CText

image   Background image for this CText

sample   Current CSample object for this ptext

x   Current x-position of this ptext

y   Current y-position of this ptext

z   Current x-position of this ptext

Methods
addBehavior ( )   Add a new Behavior to the CText's run queue

align ( )   Sets text mode for CText object.

boundingBoxFill ( )   Set the current boundingBoxFill color for this object, applicable only when showBoundingBox(true) has been called.

boundingBoxPadding ( )   Sets min padding (in pixels) around all sides of text in bounding box (default=1)

boundingBoxSelectedFill ( )   Set the current boundingBoxFill color for this object, applicable only when showBoundingBox(true) has been called.

boundingBoxSelectedStroke ( )   Set the selected boundingBoxStroke color for this object, applicable only when showBoundingBox(true) has been called.

boundingBoxStroke ( )   Set the current boundingBoxStroke color for this object, applicable only when showBoundingBox(true) has been called.

boundingBoxStrokeWeight ( )   Set the current bgstroke weight for this object

contains ( )   // need 3d version TODO: make work with all alignments Checks if the input point is inside the bounding box

createLines ( )   Creates an array of Ctext, one per line of input text, constrained to the maxChars specified, starting with upper left corner at startX and startY or null if null or empty input

createLinesFromFile ( )   Creates an array of Ctext from a file, one per line of input text, constrained to the default-maxChars, starting with upper left corner at startX and startY or null if null or empty input

createWords ( )   Creates an array of CTexts, one for each word of input or null if null or empty input

disableAutoDraw ( )   Disables auto-drawing of subsequently created CTexts.
Note: draw() must be explicitly called on these objects.

dispose ( )   Deletes all objects in the List.

disposeAll ( )   Deletes all current instances.

fadeAllIn ( )   Fades in all CText objects.

fadeAllOut ( )   Fades all visible CText objects.

fadeColor ( )   Transitions to new color over 'time' sec starting at 'startTime' sec from 'now'

fadeIn ( )   Fades in current pText over 'time' seconds starting at startTime seconds from 'now'

fadeOut ( )   Fades out current pText over 'time' seconds starting immediately

fill ( )   Set the current fill color for this object

getPicked ( )   // remove??? Returns all PTexts that contain the point x,y or just return CText ?

getPos ( )   Use the default Tokenizer & PosParser to return a String[]

getSelected ( )   // remove??? Returns all selected PTexts or just return CText ?

getText ( )   Returns the current text

getWordOffset ( )   Returns the pixel x-offset for the given word index.

Useful, for example, to determine the starting positions of new CTexts after a split() operation}

getX ( )   Gets the current x-position of the CText

getY ( )   Gets the current y-position of the CText

isOffscreen ( )   Returns true if the object is offscreen

moveBy ( )   Move to new position by x,y offset over 'time' seconds

moveTo ( )   Move to new absolute x,y (or x,y,z) position over 'time' seconds

pauseAllBehaviors ( )   Immediately pauses all Behaviors in all the CText's run queue

pauseBehaviors ( )   Pauses all Behaviors in the CText's run queue at 'time' seconds in the future.

regexReplace ( )   Utility method to do regex replacement on a String

regexTest ( )   Utility method to test whether a String parially matches a regex pattern.

removeBehavior ( )   Remove a Behavior from the CText's run queue

removeBehaviors ( )   Remove all Behaviors from the CText's run queue

replace ( )   Replaces all instances of oldText with newText in the object.

replaceFirst ( )   Replaces first instance of oldText with newText in the object.

scaleImage ( )   Scales the bg image by scalePercent

setAlignment ( )   Sets alignment for existing objects and sets default alignment for subsequent objects.

setAlpha ( )   Set the current alpha fill color for this object (transparency 0-255))

setBoundingBoxesVisible ( )   Sets boundingBoxes (in)visible for all existing objects.

setColor ( )   Set color for all existing objects.

setFont ( )   Sets a fonts for all existing CText objects.

setFontSize ( )   Sets default text size for all existing and future objects.

setImage ( )   Assigns a background image to this ptext

setImageBaseAligned ( )   Sets image alignment for CText object.

setImageHeight ( )   Sets height for the bg image, scaling the width appropriately.

setImageSize ( )   Sets size for the bg image

setImageWidth ( )   Sets width for the bg image, scaling the height appropriately.

setLocation ( )   Sets the location of the current CText

setSelectedColor ( )   Set the fill color for this object when selected

setText ( )   Sets the current text to the character

setVisible ( )   Sets boolean flag to show or hide the object

setX ( )   Sets the x-position of the current CText

setY ( )   Sets the y-position of the current CText

split ( )   Splits this object into an array of CTexts

textMode ( )   Sets text mode for CText object.

textSize ( )   Sets the object to this size

Usage Web & Application
Related