APIdia Launch Partner
Top Description Methods
org.w3c.dom.stylesheets

public Interface MediaList

Imports
org.w3c.dom.DOMException

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
1.4, DOM Level 2

Method Summary

Modifier and TypeMethod and Description
public void
appendMedium(String
The new medium to add.
newMedium
)

Adds the medium newMedium to the end of the list.

public void
deleteMedium(String
The medium to delete in the media list.
oldMedium
)

Deletes the medium indicated by oldMedium from the list.

public int
getLength()

The number of media in the list.

public String
getMediaText()

The parsable textual representation of the media list.

public String

Returns:

The medium at the indexth position in the MediaList, or null if that is not a valid index.
item
(int
Index into the collection.
index
)

Returns the indexth in the list.

public void
setMediaText(String mediaText)

The parsable textual representation of the media list.

Method Detail

appendMediumback to summary
public void appendMedium(String newMedium) throws DOMException

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

Parameters
newMedium:String

The new medium to add.

Exceptions
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.
deleteMediumback to summary
public void deleteMedium(String oldMedium) throws DOMException

Deletes the medium indicated by oldMedium from the list.

Parameters
oldMedium:String

The medium to delete in the media list.

Exceptions
DOMException:
NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.
NOT_FOUND_ERR: Raised if oldMedium is not in the list.
getLengthback to summary
public int getLength()

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

getMediaTextback to summary
public String getMediaText()

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

itemback to summary
public 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:int

Index into the collection.

Returns:String

The medium at the indexth position in the MediaList, or null if that is not a valid index.

setMediaTextback to summary
public void setMediaText(String mediaText) throws DOMException

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

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