org.buildmlearn.toolkit.model.TemplateInterface Interface Reference

Interface containing methods for a implementing a template. More...

Inheritance diagram for org.buildmlearn.toolkit.model.TemplateInterface:

Collaboration diagram for org.buildmlearn.toolkit.model.TemplateInterface:

Public Member Functions
BaseAdapter	newTemplateEditorAdapter (Context context)
	Called from Template Editor when template editor is started for creating a new template project. More...
BaseAdapter	newMetaEditorAdapter (Context context)
	Called from Template Editor when template editor is started for creating a new meta details of template project. More...
BaseAdapter	currentTemplateEditorAdapter ()
	This function is used to get the adapter (containing template data) for a existing/current template project. More...
BaseAdapter	currentMetaEditorAdapter ()
	This function is used to get the meta adapter (containing template meta details) for a existing/current template project. More...
BaseAdapter	loadProjectMetaEditor (Context context, Document doc)
BaseAdapter	loadProjectTemplateEditor (Context context, ArrayList< Element > data)
void	setTemplateId (int templateId)
	Set templateId,that can be used to get Info about current template from enum Template. More...
String	getTitle ()
	Used to get the title of the templaye. Mainly used to update ActionBar in Template Editor. More...
void	addItem (Activity activity)
	Add an item to template data. More...
void	addMetaData (Activity activity)
	Add MetaData to template data. More...
void	editItem (Activity activity, int position)
	Called to edit an item in the template data. More...
void	deleteItem (Activity activity, int position)
	Remove an item form template data list. More...
ArrayList< Element >	getItems (Document doc)
android.support.v4.app.Fragment	getSimulatorFragment (String filePathWithName)
	Returns a fragment required for the Simulator Activity. More...
String	getAssetsFileName (Context context)
	Name of the xml file congaing template data in the assets folders in the build apk. More...
String	getAssetsFilePath ()
	Folder path in which the apk is stored in the build APK. More...
String	getApkFilePath ()
void	onActivityResult (Context context, int requestCode, int resultCode, Intent intent)
	Called whenever onActivityResult is called in Template Editor. Can be used to perform action related to intent and callbacks. More...

Detailed Description

Interface containing methods for a implementing a template.

Each template must implement this interface. For using the template, a new enum in Template Enum is required.

Created by abhishek on 27/5/15.

Member Function Documentation

void org.buildmlearn.toolkit.model.TemplateInterface.addItem

(

Activity

activity

)

Add an item to template data.

Parameters

activity

Current Activity

void org.buildmlearn.toolkit.model.TemplateInterface.addMetaData

(

Activity

activity

)

Add MetaData to template data.

Parameters

activity

Current Activity

Implemented in org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.QuizTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, and org.buildmlearn.toolkit.templates.LearnSpellingTemplate.

BaseAdapter org.buildmlearn.toolkit.model.TemplateInterface.currentMetaEditorAdapter

(

)

This function is used to get the meta adapter (containing template meta details) for a existing/current template project.

Returns

BaseAdapter inherited Object

Implemented in org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, org.buildmlearn.toolkit.templates.LearnSpellingTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, and org.buildmlearn.toolkit.templates.QuizTemplate.

BaseAdapter org.buildmlearn.toolkit.model.TemplateInterface.currentTemplateEditorAdapter

(

)

This function is used to get the adapter (containing template data) for a existing/current template project.

Returns

BaseAdapter inherited Object

Implemented in org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, org.buildmlearn.toolkit.templates.LearnSpellingTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, and org.buildmlearn.toolkit.templates.QuizTemplate.

void org.buildmlearn.toolkit.model.TemplateInterface.deleteItem	(	Activity	activity,
		int	position
	)

Remove an item form template data list.

Parameters

activity	Current Activity
position	Position of the item to be removed

Implemented in org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.QuizTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, and org.buildmlearn.toolkit.templates.LearnSpellingTemplate.

void org.buildmlearn.toolkit.model.TemplateInterface.editItem	(	Activity	activity,
		int	position
	)

Called to edit an item in the template data.

Parameters

activity	Current activity
position	Position of the item in the template data list

String org.buildmlearn.toolkit.model.TemplateInterface.getApkFilePath

(

)

Path of the apk stored in assets

Returns

Apk file path

Implemented in org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.QuizTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, and org.buildmlearn.toolkit.templates.LearnSpellingTemplate.

String org.buildmlearn.toolkit.model.TemplateInterface.getAssetsFileName

(

Context

context

)

Name of the xml file congaing template data in the assets folders in the build apk.

Parameters

context

For obtaining String from StringRes

Returns

Asset file name

Implemented in org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.QuizTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, and org.buildmlearn.toolkit.templates.LearnSpellingTemplate.

String org.buildmlearn.toolkit.model.TemplateInterface.getAssetsFilePath

(

)

Folder path in which the apk is stored in the build APK.

Returns

Assets folder path

Implemented in org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.QuizTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, and org.buildmlearn.toolkit.templates.LearnSpellingTemplate.

ArrayList<Element> org.buildmlearn.toolkit.model.TemplateInterface.getItems

(

Document

doc

)

Implemented in org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.QuizTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, and org.buildmlearn.toolkit.templates.LearnSpellingTemplate.

android.support.v4.app.Fragment org.buildmlearn.toolkit.model.TemplateInterface.getSimulatorFragment

(

String

filePathWithName

)

Returns a fragment required for the Simulator Activity.

Parameters

filePathWithName

Path of the generated .buildmlearn file

Returns

Returns a fragment required for the Simulator Activity. **Dev Note: File Path should be used to populate data from actual .buildmlearn file in the Simulator.

Implemented in org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.QuizTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, and org.buildmlearn.toolkit.templates.LearnSpellingTemplate.

String org.buildmlearn.toolkit.model.TemplateInterface.getTitle

(

)

Used to get the title of the templaye. Mainly used to update ActionBar in Template Editor.

Returns

Title as a string

Implemented in org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, org.buildmlearn.toolkit.templates.LearnSpellingTemplate, and org.buildmlearn.toolkit.templates.QuizTemplate.

BaseAdapter org.buildmlearn.toolkit.model.TemplateInterface.loadProjectMetaEditor	(	Context	context,
		Document	doc
	)

Implemented in org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, org.buildmlearn.toolkit.templates.LearnSpellingTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, and org.buildmlearn.toolkit.templates.QuizTemplate.

BaseAdapter org.buildmlearn.toolkit.model.TemplateInterface.loadProjectTemplateEditor	(	Context	context,
		ArrayList< Element >	data
	)

Implemented in org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, org.buildmlearn.toolkit.templates.LearnSpellingTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, and org.buildmlearn.toolkit.templates.QuizTemplate.

BaseAdapter org.buildmlearn.toolkit.model.TemplateInterface.newMetaEditorAdapter

(

Context

context

)

Called from Template Editor when template editor is started for creating a new meta details of template project.

Parameters

context

Application context

Returns

BaseAdapter inherited Object

Implemented in org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, org.buildmlearn.toolkit.templates.LearnSpellingTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, and org.buildmlearn.toolkit.templates.QuizTemplate.

BaseAdapter org.buildmlearn.toolkit.model.TemplateInterface.newTemplateEditorAdapter

(

Context

context

)

Called from Template Editor when template editor is started for creating a new template project.

Parameters

context

Application context

Returns

BaseAdapter inherited Object

Implemented in org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, org.buildmlearn.toolkit.templates.LearnSpellingTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, and org.buildmlearn.toolkit.templates.QuizTemplate.

void org.buildmlearn.toolkit.model.TemplateInterface.onActivityResult	(	Context	context,
		int	requestCode,
		int	resultCode,
		Intent	intent
	)

Called whenever onActivityResult is called in Template Editor. Can be used to perform action related to intent and callbacks.

Parameters

context
requestCode
resultCode
intent

Implemented in org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.QuizTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, and org.buildmlearn.toolkit.templates.LearnSpellingTemplate.

void org.buildmlearn.toolkit.model.TemplateInterface.setTemplateId

(

int

templateId

)

Set templateId,that can be used to get Info about current template from enum Template.

Parameters

templateId

Implemented in org.buildmlearn.toolkit.templates.ComprehensionTemplate, org.buildmlearn.toolkit.templates.VideoCollectionTemplate, org.buildmlearn.toolkit.templates.MatchTemplate, org.buildmlearn.toolkit.templates.DictationTemplate, org.buildmlearn.toolkit.templates.FlashTemplate, org.buildmlearn.toolkit.templates.InfoTemplate, org.buildmlearn.toolkit.templates.LearnSpellingTemplate, and org.buildmlearn.toolkit.templates.QuizTemplate.

---

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

• source-code/app/src/main/java/org/buildmlearn/toolkit/model/TemplateInterface.java