Class Index | File Index

Classes


Class Filter


Defined in: FilterClasses.jsm.

Class Summary
Constructor Attributes Constructor Name and Description
 
Filter(text)
Abstract base class for filters
Field Summary
Field Attributes Field Name and Description
<static>  
Regular expression that element hiding filters should match
<static>  
Filter.knownFilters
Cache for known filters, maps string representation to filter objects.
<static>  
Filter.optionsRegExp
Regular expression that options on a RegExp filter should match
<static>  
Filter.regexpRegExp
Regular expression that RegExp filters specified as RegExps should match
 
Filter subscriptions the filter belongs to
 
String representation of the filter
Method Summary
Method Attributes Method Name and Description
<static>  
Filter.fromObject(obj)
Deserializes a filter
<static>  
Filter.fromText(text)
Creates a filter of correct type from its text representation - does the basic parsing and calls the right constructor then.
<static>  
Filter.normalize(text)
Removes unnecessary whitespaces from filter text, will only return null if the input parameter is null.
 
serialize(buffer)
Serializes the filter to an array of strings for writing out on the disk.
 
Class Detail
Filter(text)
Abstract base class for filters
Parameters:
{String} text
string representation of the filter
Field Detail
<static> {RegExp} Filter.elemhideRegExp
Regular expression that element hiding filters should match

<static> {Object} Filter.knownFilters
Cache for known filters, maps string representation to filter objects.

<static> {RegExp} Filter.optionsRegExp
Regular expression that options on a RegExp filter should match

<static> {RegExp} Filter.regexpRegExp
Regular expression that RegExp filters specified as RegExps should match

{Array of Subscription} subscriptions
Filter subscriptions the filter belongs to

{String} text
String representation of the filter
Method Detail
<static> {Filter} Filter.fromObject(obj)
Deserializes a filter
Parameters:
{Object} obj
map of serialized properties and their values
Returns:
{Filter} filter or null if the filter couldn't be created

<static> {Filter} Filter.fromText(text)
Creates a filter of correct type from its text representation - does the basic parsing and calls the right constructor then.
Parameters:
{String} text
as in Filter()
Returns:
{Filter} filter or null if the filter couldn't be created

<static> {String} Filter.normalize(text)
Removes unnecessary whitespaces from filter text, will only return null if the input parameter is null.
Parameters:
{String} text

serialize(buffer)
Serializes the filter to an array of strings for writing out on the disk.
Parameters:
{Array of String} buffer
buffer to push the serialization results into

toString()

Documentation generated by JsDoc Toolkit 2.3.2 on Wed May 09 2012 10:50:20 GMT+0000 (UTC)