public interface

MediaList

org.w3c.dom.stylesheets.MediaList

Class Overview

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.

Summary

Public Methods
abstract void appendMedium(String newMedium)
Adds the medium newMedium to the end of the list.
abstract void deleteMedium(String oldMedium)
Deletes the medium indicated by oldMedium from the list.
abstract int getLength()
The number of media in the list.
abstract String getMediaText()
The parsable textual representation of the media list.
abstract String item(int index)
Returns the indexth in the list.
abstract void setMediaText(String mediaText)
The parsable textual representation of the media list.

Public Methods

public abstract void appendMedium (String newMedium)

Adds the medium newMedium to the end of the list. If the newMedium is already used, it is first removed.

Parameters
newMedium The new medium to add.
Throws
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.

public abstract void deleteMedium (String oldMedium)

Deletes the medium indicated by oldMedium from the list.

Parameters
oldMedium The medium to delete in the media list.
Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.
NOT_FOUND_ERR: Raised if oldMedium is not in the list.

public abstract int getLength ()

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

public abstract String getMediaText ()

The parsable textual representation of the media list. This is a comma-separated list of media.

public abstract 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.

public abstract void setMediaText (String mediaText)

The parsable textual representation of the media list. This is a comma-separated list of media.

Throws
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.