AjaxUrlInfo (Apache Beehive NetUI API Documentation (Version 1.0.2))

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.beehive.netui.core.urls
Class AjaxUrlInfo

Object
  AjaxUrlInfo

public class AjaxUrlInfo
extends Object
extends Object

This is a class that acts as a data structure for the information for an AJAX request. An AJAX URL has the following shape commandPrefix]component-directed-command.xhr?[component-parameters]&ajaxParameter

Field Summary
`static String`	`AJAX_PARAMTER_NAME` When an AJAX request is made, this is the name of the hidden field or URL paramter that contains the Ajax Paramter property.

Constructor Summary
`AjaxUrlInfo(String commandPrefix, String ajaxParameter)`

Method Summary
`String`	`getAjaxParameter()` Property getter for the AjaxParamter.
`String`	`getCommandPrefix()` Property getter for the Command Prefix.

Methods inherited from class Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

AJAX_PARAMTER_NAME

public static final String AJAX_PARAMTER_NAME

When an AJAX request is made, this is the name of the hidden field or URL paramter that contains the Ajax Paramter property.

See Also:: Constant Field Values

Constructor Detail

AjaxUrlInfo

public AjaxUrlInfo(String commandPrefix,
                   String ajaxParameter)

Method Detail

getCommandPrefix

public String getCommandPrefix()

Property getter for the Command Prefix.

Returns:: return the prefix to the AJAX command

getAjaxParameter

public String getAjaxParameter()

Property getter for the AjaxParamter. This paramter must be URL encoded when added to a URL.

Returns:: return the AJAX Paramter