elemental.html.MediaQueryList Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 Google Inc.
 * 
 * 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.
 */
package elemental.html;

import elemental.events.*;
import elemental.util.*;
import elemental.dom.*;
import elemental.html.*;
import elemental.css.*;
import elemental.stylesheets.*;

import java.util.Date;

/**
  * DRAFT
This page is not complete.



A MediaQueryList object maintains a list of media queries on a document
, and handles sending notifications to listeners when the media queries on the document change.
This makes it possible to observe a document to detect when its media queries change, instead of polling the values periodically, if you need to programmatically detect changes to the values of media queries on a document.
  */
public interface MediaQueryList {


  /**
    * true if the document
 currently matches the media query list; otherwise false. Read only.
    */
  boolean isMatches();


  /**
    * The serialized media query list.
    */
  String getMedia();


  /**
    * Adds a new listener to the media query list. If the specified listener is already in the list, this method has no effect.

Parameters
 listener
 The MediaQueryListListener
 to invoke when the media query's evaluated result changes.
 
    */
  void addListener(MediaQueryListListener listener);


  /**
    * Removes a listener from the media query list. Does nothing if the specified listener isn't already in the list. 

Parameters
 listener
 The MediaQueryListListener
 to stop calling on changes to the media query's evaluated result.


    */
  void removeListener(MediaQueryListListener listener);
}