org.w3c.dom.stylesheets
Interface MediaList


public interface MediaList

The MediaList interface provides the abstraction of an ordered collection of media, without defining or constraining how this collection is implemented. An empty list is the same as a list that contains the medium "all".

The items in the MediaList are accessible via an integral index, starting from 0.

See also the Document Object Model (DOM) Level 2 Style Specification.

Since:
DOM Level 2

Method Summary
 void appendMedium sample code for org.w3c.dom.stylesheets.MediaList.appendMedium(java.lang.String) definition code for org.w3c.dom.stylesheets.MediaList.appendMedium(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  newMedium)
          Adds the medium newMedium to the end of the list.
 void deleteMedium sample code for org.w3c.dom.stylesheets.MediaList.deleteMedium(java.lang.String) definition code for org.w3c.dom.stylesheets.MediaList.deleteMedium(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  oldMedium)
          Deletes the medium indicated by oldMedium from the list.
 int getLength sample code for org.w3c.dom.stylesheets.MediaList.getLength() definition code for org.w3c.dom.stylesheets.MediaList.getLength() ()
          The number of media in the list.
 String sample code for java.lang.String definition code for java.lang.String getMediaText sample code for org.w3c.dom.stylesheets.MediaList.getMediaText() definition code for org.w3c.dom.stylesheets.MediaList.getMediaText() ()
          The parsable textual representation of the media list.
 String sample code for java.lang.String definition code for java.lang.String item sample code for org.w3c.dom.stylesheets.MediaList.item(int) definition code for org.w3c.dom.stylesheets.MediaList.item(int) (int index)
          Returns the indexth in the list.
 void setMediaText sample code for org.w3c.dom.stylesheets.MediaList.setMediaText(java.lang.String) definition code for org.w3c.dom.stylesheets.MediaList.setMediaText(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  mediaText)
           
 

Method Detail

getMediaText sample code for org.w3c.dom.stylesheets.MediaList.getMediaText() definition code for org.w3c.dom.stylesheets.MediaList.getMediaText()

String sample code for java.lang.String definition code for java.lang.String  getMediaText()
The parsable textual representation of the media list. This is a comma-separated list of media.

Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException - SYNTAX_ERR: Raised if the specified string value has a syntax error and is unparsable.
NO_MODIFICATION_ALLOWED_ERR: Raised if this media list is readonly.

setMediaText sample code for org.w3c.dom.stylesheets.MediaList.setMediaText(java.lang.String) definition code for org.w3c.dom.stylesheets.MediaList.setMediaText(java.lang.String)

void setMediaText(String sample code for java.lang.String definition code for java.lang.String  mediaText)
                  throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException

getLength sample code for org.w3c.dom.stylesheets.MediaList.getLength() definition code for org.w3c.dom.stylesheets.MediaList.getLength()

int getLength()
The number of media in the list. The range of valid media is 0 to length-1 inclusive.


item sample code for org.w3c.dom.stylesheets.MediaList.item(int) definition code for org.w3c.dom.stylesheets.MediaList.item(int)

String sample code for java.lang.String definition code for java.lang.String  item(int index)
Returns the indexth in the list. If index is greater than or equal to the number of media in the list, this returns null.

Parameters:
index - Index into the collection.
Returns:
The medium at the indexth position in the MediaList, or null if that is not a valid index.

deleteMedium sample code for org.w3c.dom.stylesheets.MediaList.deleteMedium(java.lang.String) definition code for org.w3c.dom.stylesheets.MediaList.deleteMedium(java.lang.String)

void deleteMedium(String sample code for java.lang.String definition code for java.lang.String  oldMedium)
                  throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
Deletes the medium indicated by oldMedium from the list.

Parameters:
oldMediumThe - medium to delete in the media list.
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.
NOT_FOUND_ERR: Raised if oldMedium is not in the list.

appendMedium sample code for org.w3c.dom.stylesheets.MediaList.appendMedium(java.lang.String) definition code for org.w3c.dom.stylesheets.MediaList.appendMedium(java.lang.String)

void appendMedium(String sample code for java.lang.String definition code for java.lang.String  newMedium)
                  throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
Adds the medium newMedium to the end of the list. If the newMedium is already used, it is first removed.

Parameters:
newMediumThe - new medium to add.
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: If the medium contains characters that are invalid in the underlying style language.
NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.