com.webobjects.smil
Class WOSMILMediaObject

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          com.webobjects.smil.WOSMILElement
              com.webobjects.smil.WOSMILSynchronizationElement
                  com.webobjects.smil.WOSMILMediaObject

All Implemented Interfaces:

Cloneable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, WOActionResults

public class WOSMILMediaObject

extends WOSMILSynchronizationElement

WOSMILMediaObject creates content for the SMIL media object types. SMIL defined media object elements are ref, animation, audio, img, video, text, and texstream. Bind, as appropriate, one of these strings to the mediaObjectName binding for each media object of a SMIL document. WOSMILMediaObject also inherits the attribute bindings of it's parent, WOSMILSynchronizationElement. See that class for more available bindings.

Binding	SMIL attribute
elementID	id
mediaObjectName	the smil name of the media object
mediaAbstract	abstract
duration	dur
altString	alt
regionID	region
type	type
fill	fill
author	author
begin	begin
clipBegin	clip-begin
clipEnd	clip-end
copyright	copyright
end	end
longDescription	longdesc
title	title
otherTagString	use this binding to add custom attributes

See Also:

WOSMILSynchronizationElement, Serialized Form

Nested Class Summary

Nested classes inherited from class com.webobjects.appserver.WOComponent

WOComponent.Event

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes inherited from class com.webobjects.foundation.NSValidation

NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

Constructor Summary

WOSMILMediaObject(WOContext context)
Creates a WOSMILMediaObject.

Method Summary

String	altString() Returns the value of the altString binding.
void	appendToResponse(WOResponse resp, WOContext cont) Forces the component to generate its interface and output it in the response's content.
String	author() Returns the value of the author binding.
String	begin() Returns the value of the begin binding.
String	clipBegin() Returns the value of the clipBegin binding.
String	clipEnd() Returns the value of the clipEnd binding.
String	copyright() Returns the value of the copyright binding.
NSData	data() Returns the NSData of the media this element represents.
String	duration() Returns the value of the duration binding.
String	end() Returns the value of the end binding.
String	filename() Returns the filename of the resource this media object represents.
String	fill() Returns the value of the fill binding.
String	framework() Returns the framework name that file named filename is located in.
String	href() Returns the href URL string to the media this media object represents.
String	longDescription() Returns the value of the longDescription binding.
String	mediaAbstract() Returns the value of the mediaAbstract binding.
String	mediaObjectName() Returns the value of the mediaObjectName binding.
String	mimeType() Returns the mimeType attribute string.
String	otherTagString() Returns the value of the otherTagString property.
String	regionID() Returns the value of the regionID binding.
void	setAltString(String altString) Sets the value of the altString binding.
void	setAuthor(String author) Sets the value of the author binding.
void	setBegin(String begin) Sets the value of the begin binding.
void	setClipBegin(String begin) Sets the value of the clipBegin binding.
void	setClipEnd(String clipEnd) Sets the value of the clipEnd binding.
void	setCopyright(String copyright) Sets the value of the copyright binding.
void	setData(NSData data) Sets the NSData of the media this element represents.
void	setDuration(String duration) Sets the value of the duration binding.
void	setEnd(String end) Sets the value of the end binding.
void	setFilename(String filename) Sets the filename of the resource this media object represents.
void	setFill(String fill) Sets the value of the fill binding.
void	setFramework(String name) Sets the framework name that file named filename is located in.
void	setHref(String href) Sets the href URL string to the media this media object represents.
void	setLongDescription(String description) Sets the value of the longDescription binding.
void	setMediaAbstract(String newAbstract) Sets the value of the mediaAbstract binding
void	setMediaObjectName(String name) Sets the value of the mediaObjectName binding.
void	setMimeType(String mimeType) Sets the mimeType attribute string.
void	setRegionID(String regionID) Sets the value of the regionID binding.
void	setSource(String source) Sets the source URL string.
void	setTitle(String title) Sets the value of the title binding.
void	setType(String type) Sets the value of the type binding.
String	source() Returns the URL string to the media object source.
boolean	synchronizesVariablesWithBindings() Indicates if the push-pull of values in the parent component is enabled.
String	title() Returns the value of the title binding.
String	type() Returns the value of the type binding.

Methods inherited from class com.webobjects.smil.WOSMILSynchronizationElement

setSystemBitRate, setSystemCaptions, setSystemLanguage, setSystemOverdubOrCaption, setSystemRequired, setSystemScreenDepth, setSystemScreenSize, systemBitRate, systemCaptions, systemLanguage, systemOverdubOrCaption, systemRequired, systemScreenDepth, systemScreenSize, systemTests

Methods inherited from class com.webobjects.smil.WOSMILElement

elementID, setElementID, setOtherTagString

Methods inherited from class com.webobjects.appserver.WOComponent

application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WOSMILMediaObject

public WOSMILMediaObject(WOContext context)

Creates a WOSMILMediaObject.

Parameters:

context - context this component is created with

Method Detail

altString

public String altString()

Returns the value of the altString binding.

Returns:

the value of the altString binding

appendToResponse

public void appendToResponse(WOResponse resp,
                             WOContext cont)

Description copied from class: WOComponent

Forces the component to generate its interface and output it in the response's content. Component objects associated with a response receive this message during the last phase of the component request handling, or when returned by a direct action method. In the append-to-response phase, application objects (particularly the response page instance itself) generate the HTML content of the page. WOComponent's default implementation of this method invokes the appendToResponse method on the root WOElement object of the component template, which in turn invokes appendToResponse. Subclasses of WOComponent can override this method to replace or supplement the default behavior with custom logic.

Overrides:

appendToResponse in class WOComponent

Parameters:

resp - WOResponse to add content to.

cont - WOContext of the request/response loop.

See Also:

WOComponent.invokeAction(WORequest aRequest, WOContext aContext), WOComponent.takeValuesFromRequest(WORequest aRequest, WOContext aContext)

author

public String author()

Returns the value of the author binding.

Returns:

the value of the author binding

begin

public String begin()

Returns the value of the begin binding.

Returns:

the value of the begin binding

clipBegin

public String clipBegin()

Returns the value of the clipBegin binding.

Returns:

the value of the clipBegin binding

clipEnd

public String clipEnd()

Returns the value of the clipEnd binding.

Returns:

the value of the clipEnd binding

copyright

public String copyright()

Returns the value of the copyright binding.

Returns:

the value of the copyright binding

data

public NSData data()

Returns the NSData of the media this element represents.

Returns:

the NSData of the media this element represents

duration

public String duration()

Returns the value of the duration binding.

Returns:

the value of the duration binding

end

public String end()

Returns the value of the end binding.

Returns:

the value of the end binding

filename

public String filename()

Returns the filename of the resource this media object represents.

Returns:

the filename of the resource this media object represents

fill

public String fill()

Returns the value of the fill binding.

Returns:

the value of the fill binding

framework

public String framework()

Returns the framework name that file named filename is located in.

Returns:

the framework name that file named filename is located in

href

public String href()

Returns the href URL string to the media this media object represents.

Returns:

the href URL string to the media this media object represents.

longDescription

public String longDescription()

Returns the value of the longDescription binding.

Returns:

the value of the longDescription binding

mediaAbstract

public String mediaAbstract()

Returns the value of the mediaAbstract binding.

Returns:

the value of the mediaAbstract binding

mediaObjectName

public String mediaObjectName()

Returns the value of the mediaObjectName binding.

Returns:

the value of the mediaObjectName binding

mimeType

public String mimeType()

Returns the mimeType attribute string.

Returns:

the mimeType attribute string.

otherTagString

public String otherTagString()

Description copied from class: WOSMILElement

Returns the value of the otherTagString property.

Overrides:

otherTagString in class WOSMILElement

Returns:

value of the otherTagString property

regionID

public String regionID()

Returns the value of the regionID binding.

Returns:

the value of the regionID binding

setAltString

public void setAltString(String altString)

Sets the value of the altString binding.

Parameters:

altString - value for the altString binding

setAuthor

public void setAuthor(String author)

Sets the value of the author binding.

Parameters:

author - value of the author binding

setBegin

public void setBegin(String begin)

Sets the value of the begin binding.

Parameters:

begin - value of the begin binding

setClipBegin

public void setClipBegin(String begin)

Sets the value of the clipBegin binding.

Parameters:

begin - value for the clipBegin binding

setClipEnd

public void setClipEnd(String clipEnd)

Sets the value of the clipEnd binding.

Parameters:

clipEnd - value of the clipEnd binding

setCopyright

public void setCopyright(String copyright)

Sets the value of the copyright binding.

Parameters:

copyright - value of the copyright binding

setData

public void setData(NSData data)

Sets the NSData of the media this element represents.

Parameters:

data - the NSData of the media this element represents

setDuration

public void setDuration(String duration)

Sets the value of the duration binding.

Parameters:

duration - value for the duration binding

setEnd

public void setEnd(String end)

Sets the value of the end binding.

Parameters:

end - value for the end binding

setFilename

public void setFilename(String filename)

Sets the filename of the resource this media object represents.

Parameters:

filename - the new filename.

setFill

public void setFill(String fill)

Sets the value of the fill binding.

Parameters:

fill - value for the fill binding

setFramework

public void setFramework(String name)

Sets the framework name that file named filename is located in.

Parameters:

name - the new framework name that file named filename is located in.

setHref

public void setHref(String href)

Sets the href URL string to the media this media object represents.

Parameters:

href - the new URL string to the media this media object represents.

setLongDescription

public void setLongDescription(String description)

Sets the value of the longDescription binding.

Parameters:

description - value for the longDescription binding

setMediaAbstract

public void setMediaAbstract(String newAbstract)

Sets the value of the mediaAbstract binding

Parameters:

newAbstract - value for the mediaAbstract binding

setMediaObjectName

public void setMediaObjectName(String name)

Sets the value of the mediaObjectName binding.

Parameters:

name - value for the mediaObjectName binding.

setMimeType

public void setMimeType(String mimeType)

Sets the mimeType attribute string.

Parameters:

mimeType - the new mimeType attribute string.

setRegionID

public void setRegionID(String regionID)

Sets the value of the regionID binding.

Parameters:

regionID - value for the regionID binding

setSource

public void setSource(String source)

Sets the source URL string.

Parameters:

source - the new source URL string

setTitle

public void setTitle(String title)

Sets the value of the title binding.

Parameters:

title - value for the title binding

setType

public void setType(String type)

Sets the value of the type binding.

Parameters:

type - value for the type binding

source

public String source()

Returns the URL string to the media object source.

Returns:

the URL string to the media object source

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Description copied from class: WOComponent

Indicates if the push-pull of values in the parent component is enabled. Returns whether a nested component pulls all values down from its parent and pushes all values to its parent before and after each phase of the request-response loop. This method returns false for stateless components (unless you override isStateless and return true), and true otherwise. Override this method to create a non-synchronizing component.

Overrides:

synchronizesVariablesWithBindings in class WOSMILElement

Returns:

false

title

public String title()

Returns the value of the title binding.

Returns:

the value of the title binding

type

public String type()

Returns the value of the type binding.

Returns:

the value of the type binding