IdentifyText
Extends: module:activities/text/TextActivityBase.TextActivityBase
Source: IdentifyText.js:40
This type of text activity suggests users to click on specific words or single letters of a
given text, without any help on where these elements are placed.
Constructor
new IdentifyText(
project: module:project/JClicProject.JClicProject,
): IdentifyTextIdentifyText constructor
Parameters
project(module:project/JClicProject.JClicProject) — The project to which this activity belongs
Instance Methods
getMinNumActions(): number
Inherited from module:activities/text/TextActivityBase.TextActivityBase#getMinNumActions
Retrieves the minimum number of actions needed to solve this activity
Returns
number
setProperties($xml: external:jQuery)
Inherited from module:Activity.Activity#setProperties
Overrides: module:activities/text/TextActivityBase.TextActivityBase#setProperties
Loads this object settings from an XML element
Parameters
$xml(external:jQuery) — The jQuery XML element to parse
readMessage(
$xml: external:jQuery,
): module:boxes/ActiveBoxContent.ActiveBoxContent
Inherited from module:Activity.Activity#readMessage
Overrides: module:activities/text/TextActivityBase.TextActivityBase#readMessage
Read an activity message from an XML element
Parameters
$xml(external:jQuery) — The XML element to be parsed
Returns
getAttributes(): object
Inherited from module:Activity.Activity#getAttributes
Overrides: module:activities/text/TextActivityBase.TextActivityBase#getAttributes
Gets a object with the basic attributes needed to rebuild this instance excluding functions,
parent references, constants and also attributes retaining the default value.
The resulting object is commonly usued to serialize elements in JSON format.
Returns
object
setAttributes(data: object)
Inherited from module:Activity.Activity#setAttributes
Overrides: module:activities/text/TextActivityBase.TextActivityBase#setAttributes
Load the activity settings from a data object
Parameters
data(object) — The data object to parse
initAutoContentProvider()
Inherited from module:Activity.Activity#initAutoContentProvider
Overrides: module:activities/text/TextActivityBase.TextActivityBase#initAutoContentProvider
Initialises the AutoContentProvider, when defined.
prepareMedia(ps: module:JClicPlayer.JClicPlayer)
Inherited from module:Activity.Activity#prepareMedia
Overrides: module:activities/text/TextActivityBase.TextActivityBase#prepareMedia
Preloads the media content of the activity.
Parameters
ps(module:JClicPlayer.JClicPlayer) — The module:JClicPlayer.JClicPlayer used to realize the media objects.
helpSolutionAllowed(): boolean
Inherited from module:Activity.Activity#helpSolutionAllowed
Overrides: module:activities/text/TextActivityBase.TextActivityBase#helpSolutionAllowed
Whether the activity allows the user to request the solution.
Returns
boolean
helpWindowAllowed(): boolean
Inherited from module:Activity.Activity#helpWindowAllowed
Overrides: module:activities/text/TextActivityBase.TextActivityBase#helpWindowAllowed
Whether the activity allows the user to request help.
Returns
boolean
mustPauseSequence(): boolean
Inherited from module:Activity.Activity#mustPauseSequence
Overrides: module:activities/text/TextActivityBase.TextActivityBase#mustPauseSequence
When this method returns true, the automatic jump to the next activity must be paused at
this activity.
Returns
boolean
canReinit(): boolean
Inherited from module:Activity.Activity#canReinit
Overrides: module:activities/text/TextActivityBase.TextActivityBase#canReinit
Whether or not the activity can be reset
Returns
boolean
hasInfo(): boolean
Inherited from module:Activity.Activity#hasInfo
Overrides: module:activities/text/TextActivityBase.TextActivityBase#hasInfo
Whether or not the activity has additional information to be shown.
Returns
boolean
hasRandom(): boolean
Inherited from module:Activity.Activity#hasRandom
Overrides: module:activities/text/TextActivityBase.TextActivityBase#hasRandom
Whether or not the activity uses random to shuffle internal components
Returns
boolean
shuffleAlways(): boolean
Inherited from module:Activity.Activity#shuffleAlways
Overrides: module:activities/text/TextActivityBase.TextActivityBase#shuffleAlways
When true, the activity must always be shuffled
Returns
boolean
needsKeyboard(): boolean
Inherited from module:Activity.Activity#needsKeyboard
Overrides: module:activities/text/TextActivityBase.TextActivityBase#needsKeyboard
When true, the activity makes use of the keyboard
Returns
boolean
end()
Inherited from module:Activity.Activity#end
Overrides: module:activities/text/TextActivityBase.TextActivityBase#end
Called when the activity must be disposed
clear()
Inherited from module:Activity.Activity#clear
Overrides: module:activities/text/TextActivityBase.TextActivityBase#clear
Called when the activity must reset its internal components
getWindowSize(): module:AWT.Dimension
Inherited from module:Activity.Activity#getWindowSize
Overrides: module:activities/text/TextActivityBase.TextActivityBase#getWindowSize
Getter method for windowSize
Returns
setWindowSize(windowSize: module:AWT.Dimension)
Inherited from module:Activity.Activity#setWindowSize
Overrides: module:activities/text/TextActivityBase.TextActivityBase#setWindowSize
Setter method for windowSize
Parameters
windowSize(module:AWT.Dimension)
getActivityPanel(
ps: module:JClicPlayer.JClicPlayer,
): module:Activity.ActivityPanel
Inherited from module:Activity.Activity#getActivityPanel
Overrides: module:activities/text/TextActivityBase.TextActivityBase#getActivityPanel
Builds the ActivityPanel object.
Subclasses must update the Panel member of its prototypes to produce specific panels.
Parameters
ps(module:JClicPlayer.JClicPlayer) — The JClicPlayer used to build media objects.
Returns
getMinNumActions(): number
Inherited from module:activities/text/TextActivityBase.TextActivityBase#getMinNumActions
Retrieves the minimum number of actions needed to solve this activity
Returns
number
Static Methods
registerClass(
activityName: string,
activityClass: function,
): module:Activity.Activity
Inherited from module:Activity.Activity
Registers a new type of activity
Parameters
activityName(string) — The name used to identify this activityactivityClass(function) — The activity class, usually extending Activity
Returns
getActivity(
data: object | external:jQuery,
project: module:project/JClicProject.JClicProject,
): module:Activity.Activity
Inherited from module:Activity.Activity
Factory constructor that returns a specific type of Activity based on the class attribute
declared in data.
Parameters
data(object | external:jQuery) — Can be a jQuery XML element, or an object obtained with a call togetAttributesproject(module:project/JClicProject.JClicProject) — The JClicProject to which this activity belongs
Returns
Instance Fields
ev: module:activities/text/Evaluator.Evaluator
Inherited from module:activities/text/TextActivityBase.TextActivityBase#ev
Overrides: module:activities/text/TextActivityBase.TextActivityBase#ev
This is the object used to evaluate user's answers in text activities.
checkButtonText: string
Inherited from module:activities/text/TextActivityBase.TextActivityBase#checkButtonText
Overrides: module:activities/text/TextActivityBase.TextActivityBase#checkButtonText
This is the label used by text activities for the check button, when present.
prevScreen: boolean
Inherited from module:activities/text/TextActivityBase.TextActivityBase#prevScreen
Overrides: module:activities/text/TextActivityBase.TextActivityBase#prevScreen
When true, a text will be shown before the beginning of the activity.
prevScreenText: string
Inherited from module:activities/text/TextActivityBase.TextActivityBase#prevScreenText
Overrides: module:activities/text/TextActivityBase.TextActivityBase#prevScreenText
Optional text to be shown before the beginning of the activity. When null, this text is
the main document.
prevScreenStyle: module:boxes/BoxBase.BoxBase
Inherited from module:activities/text/TextActivityBase.TextActivityBase#prevScreenStyle
Overrides: module:activities/text/TextActivityBase.TextActivityBase#prevScreenStyle
The style of the optional text to be shown before the beginning of the activity.
prevScreenMaxTime: number
Inherited from module:activities/text/TextActivityBase.TextActivityBase#prevScreenMaxTime
Overrides: module:activities/text/TextActivityBase.TextActivityBase#prevScreenMaxTime
Maximum amount of time for showing the previous document.
project: module:project/JClicProject.JClicProject
Inherited from module:Activity.Activity#project
Overrides: module:activities/text/TextActivityBase.TextActivityBase#project
The JClicProject to which this activity belongs
name: string
Inherited from module:Activity.Activity#name
Overrides: module:activities/text/TextActivityBase.TextActivityBase#name
The Activity name
className: string
Inherited from module:Activity.Activity#className
Overrides: module:activities/text/TextActivityBase.TextActivityBase#className
The class name of this Activity
code: string
Inherited from module:Activity.Activity#code
Overrides: module:activities/text/TextActivityBase.TextActivityBase#code
Code used in reports to filter queries. Default is null.
type: string
Inherited from module:Activity.Activity#type
Overrides: module:activities/text/TextActivityBase.TextActivityBase#type
Type of activity, used in text activities to distinguish between different variants of the
same activity. Possible values are: orderWords, orderParagraphs, identifyWords and
identifyChars.
description: string
Inherited from module:Activity.Activity#description
Overrides: module:activities/text/TextActivityBase.TextActivityBase#description
A short description of the activity
margin: number
Inherited from module:Activity.Activity#margin
Overrides: module:activities/text/TextActivityBase.TextActivityBase#margin
The space between the activity components measured in pixels.
bgColor: string
Inherited from module:Activity.Activity#bgColor
Overrides: module:activities/text/TextActivityBase.TextActivityBase#bgColor
The background color of the activity panel
bgGradient: module:AWT.Gradient
Inherited from module:Activity.Activity#bgGradient
Overrides: module:activities/text/TextActivityBase.TextActivityBase#bgGradient
When set, gradient used to draw the activity window background
tiledBgImg: boolean
Inherited from module:Activity.Activity#tiledBgImg
Overrides: module:activities/text/TextActivityBase.TextActivityBase#tiledBgImg
Whether the bgImage (if any) has to be tiled across the panel background
bgImageFile: string
Inherited from module:Activity.Activity#bgImageFile
Overrides: module:activities/text/TextActivityBase.TextActivityBase#bgImageFile
Filename of the image used as a panel background.
border: boolean
Inherited from module:Activity.Activity#border
Overrides: module:activities/text/TextActivityBase.TextActivityBase#border
Whether to draw a border around the activity panel
absolutePositioned: boolean
Inherited from module:Activity.Activity#absolutePositioned
Overrides: module:activities/text/TextActivityBase.TextActivityBase#absolutePositioned
Whether to place the activity panel at the point specified by absolutePosition or leave
it centered on the main player's window.
absolutePosition: module:AWT.Point
Inherited from module:Activity.Activity#absolutePosition
Overrides: module:activities/text/TextActivityBase.TextActivityBase#absolutePosition
The position of the activity panel on the player.
includeInReports: boolean
Inherited from module:Activity.Activity#includeInReports
Overrides: module:activities/text/TextActivityBase.TextActivityBase#includeInReports
Whether to generate usage reports
reportActions: boolean
Inherited from module:Activity.Activity#reportActions
Overrides: module:activities/text/TextActivityBase.TextActivityBase#reportActions
Whether to send action events to the Reporter
helpWindow: boolean
Inherited from module:Activity.Activity#helpWindow
Overrides: module:activities/text/TextActivityBase.TextActivityBase#helpWindow
Whether to allow help about the activity or not.
showSolution: boolean
Inherited from module:Activity.Activity#showSolution
Overrides: module:activities/text/TextActivityBase.TextActivityBase#showSolution
Whether to show the solution on the help window.
helpMsg: string
Inherited from module:Activity.Activity#helpMsg
Overrides: module:activities/text/TextActivityBase.TextActivityBase#helpMsg
Message to be shown in the help window when showSolution is false.
eventSounds: module:media/EventSounds.EventSounds
Inherited from module:Activity.Activity#eventSounds
Overrides: module:activities/text/TextActivityBase.TextActivityBase#eventSounds
Specific set of EventSounds used in the activity. The default is null, meaning
to use the default event sounds.
useOrder: boolean
Inherited from module:Activity.Activity#useOrder
Overrides: module:activities/text/TextActivityBase.TextActivityBase#useOrder
Wheter the activity must be solved in a specific order or not.
dragCells: boolean
Inherited from module:Activity.Activity#dragCells
Overrides: module:activities/text/TextActivityBase.TextActivityBase#dragCells
Wheter the cells of the activity will be dragged across the screen.
When false, a line will be painted to link elements.
skinFileName: string
Inherited from module:Activity.Activity#skinFileName
Overrides: module:activities/text/TextActivityBase.TextActivityBase#skinFileName
File name of the Skin used by the activity. The default value is null, meaning that the
activity will use the skin specified for the project.
maxTime: number
Inherited from module:Activity.Activity#maxTime
Overrides: module:activities/text/TextActivityBase.TextActivityBase#maxTime
Maximum amount of time (seconds) to solve the activity. The default value is 0, meaning
unlimited time.
countDownTime: boolean
Inherited from module:Activity.Activity#countDownTime
Overrides: module:activities/text/TextActivityBase.TextActivityBase#countDownTime
Whether the time counter should display a countdown when maxTime > 0
maxActions: number
Inherited from module:Activity.Activity#maxActions
Overrides: module:activities/text/TextActivityBase.TextActivityBase#maxActions
Maximum number of actions allowed to solve the activity. The default value is 0, meaning
unlimited actions.
countDownActions: boolean
Inherited from module:Activity.Activity#countDownActions
Overrides: module:activities/text/TextActivityBase.TextActivityBase#countDownActions
Whether the actions counter should display a countdown when maxActions > 0
infoUrl: string
Inherited from module:Activity.Activity#infoUrl
Overrides: module:activities/text/TextActivityBase.TextActivityBase#infoUrl
URL to be launched when the user clicks on the 'info' button. Default is null.
infoCmd: string
Inherited from module:Activity.Activity#infoCmd
Overrides: module:activities/text/TextActivityBase.TextActivityBase#infoCmd
System command to be launched when the user clicks on the 'info' button. Default is null.
Important: this parameter is currently not being used
messages: Array.<module:boxes/ActiveBoxContent.ActiveBoxContent>
Inherited from module:Activity.Activity#messages
Overrides: module:activities/text/TextActivityBase.TextActivityBase#messages
The content of the initial, final, previous and error messages shown by the activity.
windowSize: module:AWT.Dimension
Inherited from module:Activity.Activity#windowSize
Overrides: module:activities/text/TextActivityBase.TextActivityBase#windowSize
Preferred dimension of the activity window
transparentBg: boolean
Inherited from module:Activity.Activity#transparentBg
Overrides: module:activities/text/TextActivityBase.TextActivityBase#transparentBg
Whether the activity window has transparent background.
activityBgColor: string
Inherited from module:Activity.Activity#activityBgColor
Overrides: module:activities/text/TextActivityBase.TextActivityBase#activityBgColor
The background color of the activity
activityBgGradient: module:AWT.Gradient
Inherited from module:Activity.Activity#activityBgGradient
Overrides: module:activities/text/TextActivityBase.TextActivityBase#activityBgGradient
Gradient used to draw backgrounds inside the activity.
bTimeCounter: boolean
Inherited from module:Activity.Activity#bTimeCounter
Overrides: module:activities/text/TextActivityBase.TextActivityBase#bTimeCounter
Whether to display or not the 'time' counter
bScoreCounter: boolean
Inherited from module:Activity.Activity#bScoreCounter
Overrides: module:activities/text/TextActivityBase.TextActivityBase#bScoreCounter
Whether to display or not the 'score' counter
bActionsCounter: boolean
Inherited from module:Activity.Activity#bActionsCounter
Overrides: module:activities/text/TextActivityBase.TextActivityBase#bActionsCounter
Whether to display or not the 'actions' counter
acp: module:automation/AutoContentProvider.AutoContentProvider
Inherited from module:Activity.Activity#acp
Overrides: module:activities/text/TextActivityBase.TextActivityBase#acp
Special object used to generate random content at the start of the activity
abc: Array.<module:boxes/ActiveBagContent.ActiveBagContent>
Inherited from module:Activity.Activity#abc
Overrides: module:activities/text/TextActivityBase.TextActivityBase#abc
Array of bags with the description of the content to be displayed on panels and cells.
tgc: module:boxes/TextGridContent.TextGridContent
Inherited from module:Activity.Activity#tgc
Overrides: module:activities/text/TextActivityBase.TextActivityBase#tgc
Content of the grid of letters used in crosswords and shuffled letters
document: module:activities/text/TextActivityDocument.TextActivityDocument
Inherited from module:Activity.Activity#document
Overrides: module:activities/text/TextActivityBase.TextActivityBase#document
The main document used in text activities
boxGridPos: string
Inherited from module:Activity.Activity#boxGridPos
Overrides: module:activities/text/TextActivityBase.TextActivityBase#boxGridPos
Relative position of the text grid (uses the same position codes as box grids)
shuffles: number
Inherited from module:Activity.Activity#shuffles
Overrides: module:activities/text/TextActivityBase.TextActivityBase#shuffles
Number of times to shuffle the cells at the beginning of the activity
shuffleA: boolean
Inherited from module:Activity.Activity#shuffleA
Overrides: module:activities/text/TextActivityBase.TextActivityBase#shuffleA
Box grid A must be shuffled.
shuffleB: boolean
Inherited from module:Activity.Activity#shuffleB
Overrides: module:activities/text/TextActivityBase.TextActivityBase#shuffleB
Box grid B must be shuffled.
invAss: boolean
Inherited from module:Activity.Activity#invAss
Overrides: module:activities/text/TextActivityBase.TextActivityBase#invAss
Flag to indicate "inverse resolution" in complex associations
menuElements: Array.<object>
Inherited from module:Activity.Activity#menuElements
Overrides: module:activities/text/TextActivityBase.TextActivityBase#menuElements
Array of menu elements, used in activities of type Menu
numericContent: boolean
Inherited from module:Activity.Activity#numericContent
Overrides: module:activities/text/TextActivityBase.TextActivityBase#numericContent
This activity uses numeric expressions, so text literals should be
converted to numbers for comparisions, taking in account the
number format of the current locale (dot or comma as decimal separator)
Static Fields
Panel: class
Panel class associated to this type of activity: IdentifyTextPanel
CLASSES: object
Inherited from module:Activity.Activity
Classes derived from Activity should register themselves by adding a field to
Activity.CLASSES using Activity.registerClass