Class Biojs.HelloWorld

Version 1.0.0.

Extends Biojs.

Defined in: Biojs.HelloWorld.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Biojs.HelloWorld(options) This is the description of the HelloWorld component.

Field Summary
Field Attributes	Field Name and Description
<inner>	eventTypes Array containing the supported event names
<inner>	opt Default values for the options

Method Summary
Method Attributes	Method Name and Description
	constructor(options)
	setSize(size) Change the font size.

Methods borrowed from class Biojs:: addListener, extend, getId, listen, raiseEvent, setEventHandlers, setOptions

Event Summary
Event Attributes	Event Name and Description
	onClick(actionPerformed)
	onHelloSelected(actionPerformed)

Class Detail

Biojs.HelloWorld(options)

This is the description of the HelloWorld component. Here you can set any HTML text for putting on the generated documentation.
Author: John Gomez.

var instance = new Biojs.HelloWorld({
		target : "YourOwnDivId",
		selectionBackgroundColor : '#99FF00'
});

Options detailed:
{string} target: Identifier of the DIV tag where the component should be displayed.
{string} [fontFamily='"Andale: mono", courier, monospace'] Font list to be applied to the component content.
{string} [fontColor="white"]: HTML color code for the font.
{string} [backgroundColor="#7BBFE9"]: Background color for the entire div content.
{Object} [selectionFontColor="white"]: This color will be used to change the font color of selected text.
{Object} [: selectionBackgroundColor="yellow"] This color will be used to change the background of selected text.

Field Detail

<inner> eventTypes

Array containing the supported event names

<inner> opt

Default values for the options

Method Detail

constructor(options)

setSize(size)

Change the font size. Do nothing it no value is provided.

instance.setSize("72px");

Event Detail

onClick(actionPerformed)

instance.onClick(
   function( objEvent ) {
      alert("The character " + objEvent.selected + " was clicked.");
   }
);

Parameters:
{function} actionPerformed: A function which receives an Biojs.Event object as argument.

onHelloSelected(actionPerformed)

instance.onHelloSelected(
   function( objEvent ) {
      alert("The word " + objEvent.textSelected + " was selected.");
   }
);

Parameters:
{function} actionPerformed: A function which receives an Biojs.Event object as argument.

Classes