christophedelory.rss
Class TextInput

java.lang.Object
  christophedelory.rss.TextInput

public class TextInput
extends Object

Specifies a text input box that can be displayed with the channel. The purpose of this element is something of a mystery. You can use it to specify a search engine box. Or to allow a reader to provide feedback. Most aggregators ignore it.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

TextInput()

Method Summary

String	getDescription() Returns the explanation for the text input area.
URI	getLink() Returns the URL of the CGI script that processes text input requests.
String	getLinkString() Returns the URL of the CGI script that processes text input requests.
String	getName() Returns the name of the text object in the text input area.
String	getTitle() Returns the label of the Submit button in the text input area.
void	setDescription(String description) Initializes the explanation for the text input area.
void	setLink(URI link) Initializes the URL of the CGI script that processes text input requests.
void	setLinkString(String link) Initializes the URL of the CGI script that processes text input requests.
void	setName(String name) Initializes the name of the text object in the text input area.
void	setTitle(String title) Initializes the label of the Submit button in the text input area.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextInput

public TextInput()

Method Detail

setTitle

public void setTitle(String title)

Initializes the label of the Submit button in the text input area.

Parameters:

title - a button label. Shall not be null.

Throws:

NullPointerException - if title is null.

See Also:

getTitle()

getTitle

public String getTitle()

Returns the label of the Submit button in the text input area. No default value.

Returns:

a button label. May be null if not yet initialized.

See Also:

setTitle(java.lang.String)

getDescription

public String getDescription()

Returns the explanation for the text input area.

Returns:

the text input description. May be null if not yet initialized.

See Also:

setDescription(java.lang.String)

setDescription

public void setDescription(String description)

Initializes the explanation for the text input area.

Parameters:

description - the text input description. Shall not be null.

Throws:

NullPointerException - if description is null.

See Also:

getDescription()

setName

public void setName(String name)

Initializes the name of the text object in the text input area.

Parameters:

name - a name. Shall not be null.

Throws:

NullPointerException - if name is null.

See Also:

getName()

getName

public String getName()

Returns the name of the text object in the text input area. No default value.

Returns:

a name. May be null if not yet initialized.

See Also:

setName(java.lang.String)

getLinkString

public String getLinkString()

Returns the URL of the CGI script that processes text input requests.

Returns:

an URL as a string. Shall not be null.

Throws:

NullPointerException - if no link has been defined in this text input description.

See Also:

setLinkString(java.lang.String), getLink()

setLinkString

public void setLinkString(String link)
                   throws URISyntaxException

Initializes the URL of the CGI script that processes text input requests.

Parameters:

link - an URL as a string. Shall not be null.

Throws:

NullPointerException - if link is null.

URISyntaxException - if the given string violates RFC 2396, as augmented by the URI deviations.

See Also:

getLinkString(), setLink(java.net.URI)

setLink

public void setLink(URI link)

Initializes the URL of the CGI script that processes text input requests.

Parameters:

link - an URL. Shall not be null.

Throws:

NullPointerException - if link is null.

See Also:

getLink(), setLinkString(java.lang.String)

getLink

public URI getLink()

Returns the URL of the CGI script that processes text input requests. No default value.

Returns:

an URL. May be null if not yet initialized.

See Also:

setLink(java.net.URI), getLinkString()