er.extensions.components

Class ERXLinkButton

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WODynamicElement

com.webobjects.appserver._private.WODynamicGroup

com.webobjects.appserver._private.WOHTMLDynamicElement

er.extensions.components.ERXLinkButton

public class ERXLinkButton
extends com.webobjects.appserver._private.WOHTMLDynamicElement

This dynamic element produces markup like <a><button>...</button></a>. This allows for consistent markup for all links and buttons that make use of this element. Outside of forms, it uses the combo like a link, populating the href attribute of the anchor element. Inside of forms, it defaults to using the combo as a button instead. Since IE is unable to correctly use the <button> element, the default behavior is to generate IE conditionals around the element and use simple <a> tags for links and <input> for buttons. Any unnamed bindings are passed through to the anchor element. (eg. title, onclick, etc.)

Author:

Ramsey Gurley

Bindings

Name	Description
action	Action method to invoke when this element is activated.
actionClass	The name of the class in which the method designated in 'directActionName' can be found. Defaults to DirectAction.
class	A class attribute to be bound to the anchor tag.
directActionName	The name of the direct action method (minus the "Action" suffix) to invoke when this element is activated. Defaults to “default”.
disabled	If evaluates to true, the button is in active.
escapeHTML	If escapeHTML evaluates to true, the string rendered by the 'string' or 'value' binding is converted so that characters which would be interpreted as HTML control characters become their escaped equivalent (this is the default).
fragmentIdentifier	Named location to display in the destination page.
href	URL to direct the browser to when the button is clicked.
id	An id attribute to be bound to the anchor tag.
name	A name attribute to be bound to the button tag. This is ignored if 'actionClass' or 'directActionName' is bound. It will not appear if the button is disabled.
pageName	Name of WebObjects page to display when the link is clicked.
queryDictionary	Takes a dictionary that should be appended to the hyperlink’s URL after a question mark character. The dictionary must be correctly encoded and will be merged with any existing query dictionary for a particular session ID.
rel	The rel attribute of the anchor tag. This binding has no effect when this element is used as a button. If the property er.extensions.ERXHyperlink.defaultNoFollow=true is used and 'action' is bound, then "nofollow" will automatically be appended.
secure	Changes the URL prefix from http to https when WebObjects generates URLs for component actions and direct actions for this element. For this attribute to have any effect, you must provide bindings either for the 'action,' 'directAction,' 'actionClass,' or 'pageName' attribute (respecting the valid combinations). This binding has no effect when this element is used as a button.
string	This binding provides the string value of the link when submit is false. If no string is provided, it falls back to the value binding. If no value is provided, no string is used. If the element has child elements, the string is ignored except when using IE conditionals.
submit	This binding is ignored and the default is false if the this element is used outside of a form, 'pageName' is bound, or 'href' is bound. Otherwise, inside of a form, the default is true. Using buttons as links will not submit form values, but can be more efficient.
useIEConditionals	When true, the element generates simple input or hyperlink elements using IE conditional comments, since IE is unable to handle button elements correctly. The default is true.
value	This binding provides the title of the button when submit is true. If no value is provided, the value falls back to the string binding. If no string binding is provided, a default value of "Submit" is used. If the element has child elements, the value is ignored except when using IE conditionals.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.webobjects.appserver.WOAssociation	_action
protected com.webobjects.appserver.WOAssociation	_actionClass
protected com.webobjects.appserver.WOAssociation	_directActionName
protected com.webobjects.appserver.WOAssociation	_disabled
protected com.webobjects.appserver.WOAssociation	_escapeHTML
protected com.webobjects.appserver.WOAssociation	_fragmentIdentifier
protected com.webobjects.appserver.WOAssociation	_href
protected com.webobjects.appserver.WOAssociation	_name
protected NSDictionary<String,com.webobjects.appserver.WOAssociation>	_otherQueryAssociations
protected com.webobjects.appserver.WOAssociation	_pageName
protected com.webobjects.appserver.WOAssociation	_queryDictionary
protected com.webobjects.appserver.WOAssociation	_rel
protected com.webobjects.appserver.WOAssociation	_string
protected com.webobjects.appserver.WOAssociation	_submit
protected com.webobjects.appserver.WOAssociation	_useIEConditionals
protected com.webobjects.appserver.WOAssociation	_value

Fields inherited from class com.webobjects.appserver._private.WOHTMLDynamicElement

_associations, _class, _constantAttributeAssociations, _constantAttributesRepresentation, _dyneltName, _finishedInitialization, _generatedId, _id, _prefix, _rendered, _secure, _style, _suffix, _title, DontEscapeHTML, EscapeHTML

Fields inherited from class com.webobjects.appserver._private.WODynamicGroup

_children

Fields inherited from class com.webobjects.appserver.WODynamicElement

_ConstructorParameters

Constructor Summary

Constructors

Constructor and Description
ERXLinkButton(String aName, NSDictionary<String,com.webobjects.appserver.WOAssociation> associations, com.webobjects.appserver.WOElement template)

Method Summary

Modifier and Type	Method and Description
protected void	_appendButtonCloseTagToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendButtonOpenTagToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendCGIActionURLToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context, boolean htmlEscapeURL)
protected void	_appendChildStringToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendCloseTagToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendClosingHrefToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendComponentActionURLToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context, boolean escapeHTML)
protected void	_appendDisabledAttributeToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendFragmentToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendIECloseTagToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendIEOpenTagToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendIEStringToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendNameAttributeToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendNotIECloseTagToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendNotIEOpenTagToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendOpeningHrefToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendOpenTagToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendQueryStringToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context, String aRequestHandlerPath, boolean htmlEscapeURL, boolean defaultIncludeSessionID)
protected void	_appendRelToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendStaticURLToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context, boolean escapeHTML)
protected void	_appendTypeAttributeToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected void	_appendValueAttributeToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
void	appendAttributesToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
void	appendChildrenToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
void	appendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected String	childStringInContext(com.webobjects.appserver.WOContext context) Returns the child string for the button supplied by the string or value attribute.
String	classInContext(com.webobjects.appserver.WOContext context)
protected String	computeActionStringInContext(com.webobjects.appserver.WOAssociation actionClass, com.webobjects.appserver.WOAssociation directActionName, com.webobjects.appserver.WOContext aContext) Overriding to prevent exceptions when actionClass or directActionName are bound, but resolve to null.
protected boolean	defaultEscapeHTML()
protected boolean	escapeHTMLInContext(com.webobjects.appserver.WOContext context)
protected String	fragmentIdentifierInContext(com.webobjects.appserver.WOContext context)
protected String	hrefInContext(com.webobjects.appserver.WOContext context)
com.webobjects.appserver.WOActionResults	invokeAction(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context) Overridden to perform the logging, propagating the action to sub-elements and returning the current page if an empty page is returned from super.
com.webobjects.appserver.WOActionResults	invokeButtonAction(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context)
com.webobjects.appserver.WOActionResults	invokeLinkAction(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context)
protected boolean	isDisabledInContext(com.webobjects.appserver.WOContext context)
String	nameInContext(com.webobjects.appserver.WOContext context)
protected boolean	submitInContext(com.webobjects.appserver.WOContext context)
void	takeValuesFromRequest(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context)
String	toString()
protected boolean	useIEConditionalsInContext(com.webobjects.appserver.WOContext context)
protected String	valueInContext(com.webobjects.appserver.WOContext context)

Methods inherited from class com.webobjects.appserver._private.WOHTMLDynamicElement

__otherQueryDictionaryInContext, __queryDictionaryInContext, _appendAttributesFromAssociationsToResponse, _appendClassAndIdToResponse, _appendTagAttributeAndValueToResponse, _frameworkNameInComponent, appendConstantAttributesToResponse, appendHiddenFieldToResponse, appendNonURLAttributesToResponse, appendURLAttributesToResponse, computeQueryDictionaryInContext, constantAttributeAssociations, constantAttributesRepresentation, elementName, escapeHTML, hasContent, idInContext, isRenderedInContext, nonUrlAttributeAssociations, prefixInContext, secureInContext, stringValueInContext, styleInContext, suffixInContext, titleInContext, urlAttributeAssociations

Methods inherited from class com.webobjects.appserver._private.WODynamicGroup

addChildElement, childrenElements, EmptyGroup, hasChildrenElements, invokeChildrenAction, takeChildrenValuesFromRequest

Methods inherited from class java.lang.Object

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

Field Detail

_otherQueryAssociations

protected NSDictionary<String,com.webobjects.appserver.WOAssociation> _otherQueryAssociations

_action

protected com.webobjects.appserver.WOAssociation _action

_actionClass

protected com.webobjects.appserver.WOAssociation _actionClass

_directActionName

protected com.webobjects.appserver.WOAssociation _directActionName

_disabled

protected com.webobjects.appserver.WOAssociation _disabled

_escapeHTML

protected com.webobjects.appserver.WOAssociation _escapeHTML

_fragmentIdentifier

protected com.webobjects.appserver.WOAssociation _fragmentIdentifier

_href

protected com.webobjects.appserver.WOAssociation _href

_name

protected com.webobjects.appserver.WOAssociation _name

_pageName

protected com.webobjects.appserver.WOAssociation _pageName

_queryDictionary

protected com.webobjects.appserver.WOAssociation _queryDictionary

_rel

protected com.webobjects.appserver.WOAssociation _rel

_string

protected com.webobjects.appserver.WOAssociation _string

_submit

protected com.webobjects.appserver.WOAssociation _submit

_useIEConditionals

protected com.webobjects.appserver.WOAssociation _useIEConditionals

_value

protected com.webobjects.appserver.WOAssociation _value

Constructor Detail

ERXLinkButton

public ERXLinkButton(String aName,
                     NSDictionary<String,com.webobjects.appserver.WOAssociation> associations,
                     com.webobjects.appserver.WOElement template)

Method Detail

takeValuesFromRequest

public void takeValuesFromRequest(com.webobjects.appserver.WORequest request,
                                  com.webobjects.appserver.WOContext context)

Overrides:

takeValuesFromRequest in class com.webobjects.appserver._private.WODynamicGroup

invokeAction

public com.webobjects.appserver.WOActionResults invokeAction(com.webobjects.appserver.WORequest request,
                                                             com.webobjects.appserver.WOContext context)

Overridden to perform the logging, propagating the action to sub-elements and returning the current page if an empty page is returned from super.

Overrides:

invokeAction in class com.webobjects.appserver._private.WODynamicGroup

invokeButtonAction

public com.webobjects.appserver.WOActionResults invokeButtonAction(com.webobjects.appserver.WORequest request,
                                                                   com.webobjects.appserver.WOContext context)

invokeLinkAction

public com.webobjects.appserver.WOActionResults invokeLinkAction(com.webobjects.appserver.WORequest request,
                                                                 com.webobjects.appserver.WOContext context)

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse response,
                             com.webobjects.appserver.WOContext context)

Overrides:

appendToResponse in class com.webobjects.appserver._private.WOHTMLDynamicElement

appendChildrenToResponse

public void appendChildrenToResponse(com.webobjects.appserver.WOResponse response,
                                     com.webobjects.appserver.WOContext context)

Overrides:

appendChildrenToResponse in class com.webobjects.appserver._private.WODynamicGroup

appendAttributesToResponse

public void appendAttributesToResponse(com.webobjects.appserver.WOResponse response,
                                       com.webobjects.appserver.WOContext context)

Overrides:

appendAttributesToResponse in class com.webobjects.appserver._private.WOHTMLDynamicElement

_appendOpenTagToResponse

protected void _appendOpenTagToResponse(com.webobjects.appserver.WOResponse response,
                                        com.webobjects.appserver.WOContext context)

Overrides:

_appendOpenTagToResponse in class com.webobjects.appserver._private.WOHTMLDynamicElement

_appendCloseTagToResponse

protected void _appendCloseTagToResponse(com.webobjects.appserver.WOResponse response,
                                         com.webobjects.appserver.WOContext context)

Overrides:

_appendCloseTagToResponse in class com.webobjects.appserver._private.WOHTMLDynamicElement

_appendQueryStringToResponse

protected void _appendQueryStringToResponse(com.webobjects.appserver.WOResponse response,
                                            com.webobjects.appserver.WOContext context,
                                            String aRequestHandlerPath,
                                            boolean htmlEscapeURL,
                                            boolean defaultIncludeSessionID)

_appendFragmentToResponse

protected void _appendFragmentToResponse(com.webobjects.appserver.WOResponse response,
                                         com.webobjects.appserver.WOContext context)

_appendCGIActionURLToResponse

protected void _appendCGIActionURLToResponse(com.webobjects.appserver.WOResponse response,
                                             com.webobjects.appserver.WOContext context,
                                             boolean htmlEscapeURL)

_appendComponentActionURLToResponse

protected void _appendComponentActionURLToResponse(com.webobjects.appserver.WOResponse response,
                                                   com.webobjects.appserver.WOContext context,
                                                   boolean escapeHTML)

_appendStaticURLToResponse

protected void _appendStaticURLToResponse(com.webobjects.appserver.WOResponse response,
                                          com.webobjects.appserver.WOContext context,
                                          boolean escapeHTML)

submitInContext

protected boolean submitInContext(com.webobjects.appserver.WOContext context)

useIEConditionalsInContext

protected boolean useIEConditionalsInContext(com.webobjects.appserver.WOContext context)

_appendOpeningHrefToResponse

protected void _appendOpeningHrefToResponse(com.webobjects.appserver.WOResponse response,
                                            com.webobjects.appserver.WOContext context)

_appendClosingHrefToResponse

protected void _appendClosingHrefToResponse(com.webobjects.appserver.WOResponse response,
                                            com.webobjects.appserver.WOContext context)

_appendButtonOpenTagToResponse

protected void _appendButtonOpenTagToResponse(com.webobjects.appserver.WOResponse response,
                                              com.webobjects.appserver.WOContext context)

_appendButtonCloseTagToResponse

protected void _appendButtonCloseTagToResponse(com.webobjects.appserver.WOResponse response,
                                               com.webobjects.appserver.WOContext context)

_appendIEOpenTagToResponse

protected void _appendIEOpenTagToResponse(com.webobjects.appserver.WOResponse response,
                                          com.webobjects.appserver.WOContext context)

_appendIECloseTagToResponse

protected void _appendIECloseTagToResponse(com.webobjects.appserver.WOResponse response,
                                           com.webobjects.appserver.WOContext context)

_appendNotIEOpenTagToResponse

protected void _appendNotIEOpenTagToResponse(com.webobjects.appserver.WOResponse response,
                                             com.webobjects.appserver.WOContext context)

_appendNotIECloseTagToResponse

protected void _appendNotIECloseTagToResponse(com.webobjects.appserver.WOResponse response,
                                              com.webobjects.appserver.WOContext context)

_appendTypeAttributeToResponse

protected void _appendTypeAttributeToResponse(com.webobjects.appserver.WOResponse response,
                                              com.webobjects.appserver.WOContext context)

_appendNameAttributeToResponse

protected void _appendNameAttributeToResponse(com.webobjects.appserver.WOResponse response,
                                              com.webobjects.appserver.WOContext context)

_appendValueAttributeToResponse

protected void _appendValueAttributeToResponse(com.webobjects.appserver.WOResponse response,
                                               com.webobjects.appserver.WOContext context)

_appendDisabledAttributeToResponse

protected void _appendDisabledAttributeToResponse(com.webobjects.appserver.WOResponse response,
                                                  com.webobjects.appserver.WOContext context)

_appendRelToResponse

protected void _appendRelToResponse(com.webobjects.appserver.WOResponse response,
                                    com.webobjects.appserver.WOContext context)

classInContext

public String classInContext(com.webobjects.appserver.WOContext context)

Overrides:

classInContext in class com.webobjects.appserver._private.WOHTMLDynamicElement

_appendIEStringToResponse

protected void _appendIEStringToResponse(com.webobjects.appserver.WOResponse response,
                                         com.webobjects.appserver.WOContext context)

_appendChildStringToResponse

protected void _appendChildStringToResponse(com.webobjects.appserver.WOResponse response,
                                            com.webobjects.appserver.WOContext context)

nameInContext

public String nameInContext(com.webobjects.appserver.WOContext context)

hrefInContext

protected String hrefInContext(com.webobjects.appserver.WOContext context)

fragmentIdentifierInContext

protected String fragmentIdentifierInContext(com.webobjects.appserver.WOContext context)

isDisabledInContext

protected boolean isDisabledInContext(com.webobjects.appserver.WOContext context)

valueInContext

protected String valueInContext(com.webobjects.appserver.WOContext context)

childStringInContext

protected String childStringInContext(com.webobjects.appserver.WOContext context)

Returns the child string for the button supplied by the string or value attribute. If submit is true, then the value binding is preferred. Otherwise, the string binding is preferred.

Parameters:

context - the current context

Returns:

the child string value

toString

public String toString()

Overrides:

toString in class com.webobjects.appserver._private.WOHTMLDynamicElement

defaultEscapeHTML

protected boolean defaultEscapeHTML()

escapeHTMLInContext

protected boolean escapeHTMLInContext(com.webobjects.appserver.WOContext context)

computeActionStringInContext

protected String computeActionStringInContext(com.webobjects.appserver.WOAssociation actionClass,
                                              com.webobjects.appserver.WOAssociation directActionName,
                                              com.webobjects.appserver.WOContext aContext)

Overriding to prevent exceptions when actionClass or directActionName are bound, but resolve to null.

Overrides:

computeActionStringInContext in class com.webobjects.appserver._private.WOHTMLDynamicElement