src/highlightablearea.js

// Copyright 2009 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @fileoverview Interface for a highlightable part of the DOM.
 */


goog.provide('bidichecker.HighlightableArea');


/**
 * Interface for classes representing a part of the DOM which can be highlighted
 * to display a BiDi error visually on the page.
 * @interface
 */
bidichecker.HighlightableArea = function() {};


/**
 * Highlights the error on the web page. Scrolls the window to bring the error
 * into view if necessary.

 *  * @return {goog.math.Coordinate} The coordinates of the start of the
 *     highlighted area.
 */
bidichecker.HighlightableArea.prototype.highlightOnPage = goog.abstractMethod;


/**
 * Unhighlights the error on the web page. If called before {@code
 * highlightOnPage()} has been called, should do nothing.
 */
bidichecker.HighlightableArea.prototype.unhighlightOnPage = goog.abstractMethod;