blob: c95a87dfb451f19d714818eaefdecb39ba8834ec [file] [log] [blame]
/*
* Copyright (C) 2014 Apple Inc. All rights reserved.
* Copyright (C) 2014 Saam Barati <saambarati1@gmail.com>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
WI.Annotator = class Annotator extends WI.Object
{
constructor(sourceCodeTextEditor)
{
super();
console.assert(sourceCodeTextEditor instanceof WI.SourceCodeTextEditor, sourceCodeTextEditor);
this._sourceCodeTextEditor = sourceCodeTextEditor;
this._timeoutIdentifier = null;
this._isActive = false;
}
// Public
get sourceCodeTextEditor()
{
return this._sourceCodeTextEditor;
}
isActive()
{
return this._isActive;
}
pause()
{
this._clearTimeoutIfNeeded();
this._isActive = false;
}
resume()
{
this._clearTimeoutIfNeeded();
this._isActive = true;
this.insertAnnotations();
}
refresh()
{
console.assert(this._isActive);
if (!this._isActive)
return;
this._clearTimeoutIfNeeded();
this.insertAnnotations();
}
reset()
{
this._clearTimeoutIfNeeded();
this._isActive = true;
this.clearAnnotations();
this.insertAnnotations();
}
clear()
{
this.pause();
this.clearAnnotations();
}
// Protected
insertAnnotations()
{
// Implemented by subclasses.
}
clearAnnotations()
{
// Implemented by subclasses.
}
// Private
_clearTimeoutIfNeeded()
{
if (this._timeoutIdentifier) {
clearTimeout(this._timeoutIdentifier);
this._timeoutIdentifier = null;
}
}
};