-
public interface MediaListTheMediaListinterface 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
MediaListare 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidappendMedium(String newMedium)Adds the mediumnewMediumto the end of the list.voiddeleteMedium(String oldMedium)Deletes the medium indicated byoldMediumfrom the list.intgetLength()The number of media in the list.StringgetMediaText()The parsable textual representation of the media list.Stringitem(int index)Returns theindexth in the list.voidsetMediaText(String mediaText)The parsable textual representation of the media list.
-
-
-
Method Detail
-
getMediaText
String getMediaText()
The parsable textual representation of the media list. This is a comma-separated list of media.
-
setMediaText
void setMediaText(String mediaText) throws DOMException
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.
-
getLength
int getLength()
The number of media in the list. The range of valid media is0tolength-1inclusive.
-
item
String item(int index)
Returns theindexth in the list. Ifindexis greater than or equal to the number of media in the list, this returnsnull.- Parameters:
index- Index into the collection.- Returns:
- The medium at the
indexth position in theMediaList, ornullif that is not a valid index.
-
deleteMedium
void deleteMedium(String oldMedium) throws DOMException
Deletes the medium indicated byoldMediumfrom 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 ifoldMediumis not in the list.
-
appendMedium
void appendMedium(String newMedium) throws DOMException
Adds the mediumnewMediumto the end of the list. If thenewMediumis 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.
-
-