WebObjects 5.2.3

com.webobjects.smil
Class WOSMILActivelink

java.lang.Object
  extended bycom.webobjects.appserver.WOElement
      extended bycom.webobjects.appserver.WOComponent
          extended bycom.webobjects.smil.WOSMILElement
              extended bycom.webobjects.smil.WOSMILActivelink
All Implemented Interfaces:
Cloneable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, WOActionResults

public class WOSMILActivelink
extends WOSMILElement

WOSmilActiveLink creates content for a SMIL "a" element. The functionality of this element is similar to the one provided by the HTML "a" element. It is interpreted as a clickable link. In fact, an alternative to using this component is to use the WOHyperlink dynamic element.

BindingSMIL attributeDescription
elementIDid
resourceURLhrefdestination for this WOSMILActivelink
actionhref (this href is a reference to the content of a WOComponent action)
showshowdetermines in which window the next presentation appears
titletitle 
otherTagString use this binding to add custom attributes

See Also:
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
WOSMILActivelink(WOContext context)
          Creates a WOSMILActivelink.
 
Method Summary
 WOElement action()
          Returns the WOElement representing the resultant page of this link's action.
 String filename()
          Returns the name of the file this WOSMILActivelink links to.
 String framework()
          Returns the framework name.
 String href()
          Returns the href attribute's URL string.
 WOComponent invokeAction()
          
 String pageName()
          Returns the name of the WOComponent this WOSMILActivelink links to.
 String resourceURL()
          Returns a string representing the value of the resourceURL binding of this WOSMILActivelink.
 void setAction(WOElement newAction)
          Sets the page component to return when this WOSMILActiveLink is activated.
 void setFilename(String newFilename)
          Sets the name of the file this WOSMILActivelink links to.
 void setFramework(String newFrameworkName)
          Sets the framework name.
 void setHref(String newHref)
          Sets href attribute's URL string.
 void setPageName(String newPageName)
          Sets the name of the WOComponent this WOSMILActivelink links to.
 void setResourceURL(String newResourceURL)
          Sets the value for the resourceURL binding.
 void setShow(String newShow)
          Sets the value for the show attribute.
 void setTitle(String newTitle)
          Sets the value for the title attribute.
 String show()
          Returns a string representing the value of the show attribute.
 String title()
          Returns a string representing the value of the title attribute.
 
Methods inherited from class com.webobjects.smil.WOSMILElement
elementID, otherTagString, setElementID, setOtherTagString, synchronizesVariablesWithBindings
 
Methods inherited from class com.webobjects.appserver.WOComponent
appendToResponse, 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

WOSMILActivelink

public WOSMILActivelink(WOContext context)
Creates a WOSMILActivelink.

Parameters:
context - context this component is created with
Method Detail

action

public WOElement action()
Returns the WOElement representing the resultant page of this link's action.

Returns:
a WOElement representing the resultant page of this link's action

filename

public String filename()
Returns the name of the file this WOSMILActivelink links to.

Returns:
the name of the file this WOSMILActivelink links to

framework

public String framework()
Returns the framework name.

Returns:
the framework name

href

public String href()
Returns the href attribute's URL string.

Returns:
href attribute's URL string

invokeAction

public WOComponent invokeAction()

Returns:

pageName

public String pageName()
Returns the name of the WOComponent this WOSMILActivelink links to.

Returns:
the name of the WOComponent this WOSMILActivelink links to

resourceURL

public String resourceURL()
Returns a string representing the value of the resourceURL binding of this WOSMILActivelink.

Returns:
string representing the value of the resourceURL binding of this WOSMILActivelink

setAction

public void setAction(WOElement newAction)
Sets the page component to return when this WOSMILActiveLink is activated.

Parameters:
newAction - the WOComponent representing the page component result of activating this WOSMILActivelink

setFilename

public void setFilename(String newFilename)
Sets the name of the file this WOSMILActivelink links to.

Parameters:
newFilename - name for the file this WOSMILActivelink links to

setFramework

public void setFramework(String newFrameworkName)
Sets the framework name.

Parameters:
newFrameworkName - name for the framework

setHref

public void setHref(String newHref)
Sets href attribute's URL string.

Parameters:
newHref - value for the href attribute's URL string

setPageName

public void setPageName(String newPageName)
Sets the name of the WOComponent this WOSMILActivelink links to.

Parameters:
newPageName - name for the WOComponent

setResourceURL

public void setResourceURL(String newResourceURL)
Sets the value for the resourceURL binding.

Parameters:
newResourceURL - value for the resourceURL attribute

setShow

public void setShow(String newShow)
Sets the value for the show attribute.

Parameters:
newShow - value for the show attribute

setTitle

public void setTitle(String newTitle)
Sets the value for the title attribute.

Parameters:
newTitle - value for the title attribute

show

public String show()
Returns a string representing the value of the show attribute.

Returns:
string representing the value of the show attribute

title

public String title()
Returns a string representing the value of the title attribute.

Returns:
string representing the value of the title attribute

Last updated Thu Oct 21 15:04:16 PDT 2004.

Copyright © 2004 Apple Computer, Inc.