net.wotonomy.web
Class WOHyperlink

java.lang.Object
  extended by net.wotonomy.web.WOElement
      extended by net.wotonomy.web.WODynamicElement
          extended by net.wotonomy.web.WOHyperlink
All Implemented Interfaces:
java.io.Serializable, WOActionResults
Direct Known Subclasses:
WOActionURL

public class WOHyperlink
extends WODynamicElement

WOHyperlink renders a dynamically generated hyperlink in the output. Bindings are:

The href, pageName and directActionName/actionClass and name properties are mutually exclusive and you should only use at most one of them simultaneously.

Version:
$Revision: 905 $
Author:
ezamudio@nasoft.com, $Author: cgruber $
See Also:
Serialized Form

Field Summary
protected  java.lang.String action
           
protected  java.lang.String actionClass
           
protected  java.lang.String anchorName
           
protected  java.lang.String directActionName
           
protected  boolean escapeHTML
           
protected  java.lang.String href
           
protected  java.lang.String pageName
           
protected  java.lang.String ref
           
protected  java.lang.String string
           
 
Fields inherited from class net.wotonomy.web.WODynamicElement
associations, name, rootElement
 
Constructor Summary
protected WOHyperlink()
           
  WOHyperlink(java.lang.String aName, net.wotonomy.foundation.NSDictionary aMap, WOElement aRootElement)
           
 
Method Summary
 java.lang.String actionClass()
           
 java.lang.String actionURL(WOContext c)
           
 java.lang.String anchorName()
           
 void appendToResponse(WOResponse r, WOContext c)
          This method is called on all elements of the content tree to build a response to a user request.
 java.lang.String directActionName()
           
 boolean escapeHTML()
          If true, inserts escape codes in to the string string so that HTML special characters (greater-than, less-than, etc.) appear correctly.
 java.lang.String href()
           
 WOActionResults invokeAction(WORequest r, WOContext c)
          This method is called on all objects and elements of the application until a non-null value is returned.
 java.lang.String pageName()
           
protected  void pullValuesFromParent(WOComponent c)
           
 void setActionClass(java.lang.String value)
           
 void setAnchorName(java.lang.String value)
           
 void setDirectActionName(java.lang.String value)
           
 void setEscapeHTML(boolean escape)
          Sets the escapeHTML property.
 void setHref(java.lang.String value)
           
 void setPageName(java.lang.String value)
           
 void setString(java.lang.String value)
           
 java.lang.String string()
           
 void takeValuesFromRequest(WORequest r, WOContext c)
          This method is called to retrieve user-entered data from the request.
 
Methods inherited from class net.wotonomy.web.WODynamicElement
generateResponse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

string

protected java.lang.String string

href

protected java.lang.String href

pageName

protected java.lang.String pageName

directActionName

protected java.lang.String directActionName

actionClass

protected java.lang.String actionClass

action

protected java.lang.String action

escapeHTML

protected boolean escapeHTML

anchorName

protected java.lang.String anchorName

ref

protected java.lang.String ref
Constructor Detail

WOHyperlink

protected WOHyperlink()

WOHyperlink

public WOHyperlink(java.lang.String aName,
                   net.wotonomy.foundation.NSDictionary aMap,
                   WOElement aRootElement)
Method Detail

setString

public void setString(java.lang.String value)

string

public java.lang.String string()

setHref

public void setHref(java.lang.String value)

href

public java.lang.String href()

setAnchorName

public void setAnchorName(java.lang.String value)

anchorName

public java.lang.String anchorName()

setPageName

public void setPageName(java.lang.String value)

pageName

public java.lang.String pageName()

setDirectActionName

public void setDirectActionName(java.lang.String value)

directActionName

public java.lang.String directActionName()

setActionClass

public void setActionClass(java.lang.String value)

actionClass

public java.lang.String actionClass()

setEscapeHTML

public void setEscapeHTML(boolean escape)
Sets the escapeHTML property.


escapeHTML

public boolean escapeHTML()
If true, inserts escape codes in to the string string so that HTML special characters (greater-than, less-than, etc.) appear correctly. If false, those characters will get interpreted by the browser. Defaults to true.


actionURL

public java.lang.String actionURL(WOContext c)

pullValuesFromParent

protected void pullValuesFromParent(WOComponent c)

appendToResponse

public void appendToResponse(WOResponse r,
                             WOContext c)
Description copied from class: WODynamicElement
This method is called on all elements of the content tree to build a response to a user request. The message should be forwarded to any child elements so that the entire tree is traversed. This implementation does nothing.

Overrides:
appendToResponse in class WODynamicElement

invokeAction

public WOActionResults invokeAction(WORequest r,
                                    WOContext c)
Description copied from class: WODynamicElement
This method is called on all objects and elements of the application until a non-null value is returned. WOElements should first check to see if they are the target of an action by checking the WOContext's senderID to see if it matches this element's elementID. If this element is the target, it should perform an appropriate action on the context's current WOComponent, usually the action specified in the binding, and return the result of that action. This implementation returns null.

Overrides:
invokeAction in class WODynamicElement

takeValuesFromRequest

public void takeValuesFromRequest(WORequest r,
                                  WOContext c)
Description copied from class: WODynamicElement
This method is called to retrieve user-entered data from the request. WOElements should retrieve data from the request based on their elementID and set values in the context's current WOComponent, typically those values that are associated with the element in the binding. This implementation does nothing.

Overrides:
takeValuesFromRequest in class WODynamicElement


Copyright © 2006 null. All Rights Reserved.