Overview of Scriptaculous Installation and documentation Autocomplete textfields Local version Ajax version In place Editor In-place Editor Free-text values Values from combo box

(1)

The Script.aculo.us JavaScript

Library Part I:

Ajax-Specific Features

j

p

Originals of Slides and Source Code for Examples:

http://courses.coreservlets.com/Course-Materials/ajax.html

Customized Java EE Training: http://courses.coreservlets.com/

Servlets, JSP, JSF 1.x& JSF 2.0, Struts Classic & Struts 2, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at yourlocation.

p

j

For live Ajax & GWT training, see training

t htt //

l t

/

courses at http://courses.coreservlets.com/.

Taught by the author of

Core Servlets and JSP

,

More

Servlets and JSP

and this tutorial Available at public

Servlets and JSP

, and this tutorial. Available at public

venues, or customized versions can be held on-site at

your organization.

C d l d d t ht b M t H ll

•Courses developed and taught by Marty Hall

–Java 6, intermediate/beginning servlets/JSP, advanced servlets/JSP, Struts, JSF 1.x& 2.0, Ajax, GWT, custom mix of topics –Ajax courses can concentrate on one library (jQuery, Prototype/Scriptaculous, Ext-JS, Dojo) or survey several

(2)

Topics in This Section

• Overview of Scriptaculous

• Installation and documentation

• Autocomplete textfields

–

Local version

–

Ajax version

• In place Editor

• In-place Editor

–

Free-text values

–

Values from combo box

5

Introduction

(3)

Overview

• Foundation

B il

f P

–

Built on top of Prototype

• Ajax-specific features

–

Autocompleting textfields

• Textfields with dropdown list of matching choices

• Covered in first half of this section

–

In-place editors

• Clickable text that you can edit and send to server

• Covered in second half of this section

• General features

–

Visual effects (fade in, fade out, highlighting)

• Covered in next section

–

Drag and drop

• Covered in later section

7

Downloading and Installation

• Download

–

http://script.aculo.us/downloads

• Unzip and grab .js files out of “src” folder

– Usually put in subdirectory of scripts since there are many filesUsually put in subdirectory of scripts since there are many files

• This tutorial corresponds to Scriptaculous 1.8.1

• Online documentation

–

http://wiki.script.aculo.us/

• Online forum

htt //

l

/

/ b

il

i ff

–

http://groups.google.com/group/rubyonrails-spinoffs

• Prerequisite

Scriptaculous requires Prototype I am using 1 6

–

Scriptaculous requires Prototype. I am using 1.6.

(4)

Autocompleter.Local

• Idea

–

Specify JavaScript array that has choices for textfield Dropdown

Specify JavaScript array that has choices for textfield. Dropdown

box shown with choices that start with what has been typed so far

• http://wiki.script.aculo.us/scriptaculous/show/Autocompletion

• Steps

–

Make an instance of Autocompleter.Local

• new Autocompleter.Local(textFieldID, divID, array)

–

Enable it when page loads

• window onload = function() { new Autocompleter Local( ); };

• window.onload = function() { new Autocompleter.Local(...); };

• Prototype gurus might use document.observe("dom:loaded",

...) instead of window.onload

–

Make an empty div with a designated CSS name

<di id "di ID" l

"

CSSN

"></di >

• <div id="divID" class="someCSSName"></div>

–

Attach style sheet that makes div absolutely positioned, puts border

on div, turns off bullets for ul lists, and makes a different

background color for li.selected

(5)

Autocompleter.Local Example:

JavaScript

var langString = "Java,C,C++,PHP,Visual Basic,..."; var langArray = languageString split(" ");

var langArray = languageString.split( , );

window.onload = function() {

new Autocompleter Local("langField1", "langMenu1", new Autocompleter.Local( langField1 , langMenu1 ,

langArray); };

function googleSearch(id) { var language = getValue(id); window.location.href =

"http://www.google.com/search?q=" + language; }

function getValue(id) {

return(escape(document.getElementById(id).value)); }

11

Autocompleter.Local Example:

HTML Header

<!DOCTYPE ...>

<html xmlns="http://www.w3.org/1999/xhtml">p // g/ /

<head><title>Scriptaculous and Autocomplete</title> <link rel="stylesheet"

href="./css/styles.css" / /

type="text/css"/>

<script src="./scripts/prototype.js" type="text/javascript"></script> <script src=sc pt s c

"./scripts/scriptaculous/scriptaculous.js?load=effects,controls" type="text/javascript"></script>

<script src="./scripts/autocomplete.js"

/ /

type="text/javascript"></script> </head>

(6)

Autocompleter.Local Example:

Main HTML

<body> ...

<fieldset>

<legend>Autocomplete.Local</legend> <form action="#">

<label for="langField1">Programming language:</label>

<input type="text" id="langField1"/>

<input type="button" value="Search on Language" onclick="googleSearch('langField1')"/><br/>

<div id="langMenu1" class="autocomplete"></div>

</form>

</fi ld t>

</fieldset> ...

</body></html>

13

Autocompleter.Local Example: CSS

.autocomplete {

position: absolute; position: absolute; color: #333333;

background-color: #ffffff; border: 1px solid #666666; border: 1px solid #666666;

font-family: Arial, sans-serif; overflow: hidden;

} }

.autocomplete ul { padding: 0;

margin: 0;a g : 0;

list-style: none; overflow: auto; }

}

(7)

Autocompleter.Local Example: CSS

(Continued)

.autocomplete li { display: block; display: block;

white-space: nowrap; cursor: pointer; margin: 0px; margin: 0px;

padding-left: 5px; padding-right: 5px;

border: 0px solid #ffffff; border: 0px solid #ffffff; }

.autocomplete li.selected {

background-color: #cceeff;

bac g ou d co o : #ccee ;

border-top: 1px solid #99bbcc; border-bottom: 1px solid #99bbcc; }

}

15

Autocompleter.Local Example:

Results

(8)

Ajax.Autocompleter

• Idea

–

Specify URL that computes list of choices Dropdown box shown

Specify URL that computes list of choices. Dropdown box shown

with choices that start with what has been typed so far

• http://wiki.script.aculo.us/scriptaculous/show/Autocompletion

• Steps: summary

–

Same steps as with Autocompleter.Local except

• Specify url instead of array (url should return <ul> list)

• Use class Ajax.Autocompleter instead of

Autocompleter.Local

• Steps

–

Make an instance of Ajax.Autocompleter

• new Ajax.Autocompleter(textFieldID, divID,

j

p

(

url

)

–

Enable it when page loads

• window.onload = function() { new Ajax.Autocompleter(...);

};

–

Make an empty div with a designated CSS name

–

Make an empty div with a designated CSS name

• <div id="divID" class="someCSSName"></div>

–

Attach same style sheet as with Autocompleter.Local

(9)

Ajax.Autocompleter Example:

JavaScript

new Autocompleter Local("langField1" "langMenu1" new Autocompleter.Local("langField1", "langMenu1",

langArray);

new Ajax.Autocompleter("langField2", "langMenu2",

"l ")

"languages"); };

This is the relative URL By default it will be passed POST

19

This is the relative URL. By default it will be passed POST data of name-of-langField2=value-of-langField2

Ajax.Autocompleter Example:

HTML

<fieldset>

<legend>Ajax Autocomplete</legend> <legend>Ajax.Autocomplete</legend> <form action="#">

<input type="text" id="langField2" p yp g name="langPrefix"g />

<input type="button" value="Search on Language" onclick="googleSearch('langField2')"/><br/> <div id="langMenu2" class="autocomplete"></div> </form>

</fieldset>

(10)

Ajax.Autocompleter Example:

Servlet

public class LanguageCompleter extends HttpServlet { private static final String languageString =

"Java,C,C++,...";

private static final String[] languageArray = languageString.split(",");

public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

response.setHeader("Cache-Control", "no-cache"); response.setHeader("Pragma", "no-cache");

String languagePrefix =

request.getParameter("langPrefix");

List<String> languages = findLanguages(languagePrefix);

The name (not id!) of textfield was "langPrefix".

g g g g g g g

request.setAttribute("languages", languages); String outputPage =

"/WEB-INF/results/language-list.jsp";

RequestDispatcher dispatcher =q p p

request.getRequestDispatcher(outputPage); dispatcher.include(request, response); } 21

Ajax.Autocompleter Example:

Servlet (Continued)

public void doPost(HttpServletRequest request, HttpServletResponse response) HttpServletResponse response) throws ServletException, IOException {

doGet(request, response); }

private List<String> findLanguages(String languagePrefix) { languagePrefix = languagePrefix.toUpperCase();

List<String> languages = new ArrayList<String>(); List<String> languages = new ArrayList<String>(); for(String language: languageArray) {

(11)

Ajax.Autocompleter Example: JSP

<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>

prefix= c %> <ul>

<c:forEach var="language" items="${languages}"> <li>${language}</li>

<li>${language}</li> </c:forEach>

</ul>

Return value of URL should be <ul>

<li>...</li>

23

... <li>...</li> </ul>

Style sheet on client will suppress the bullets.

Ajax.Autocompleter Example:

web xml

web.xml

<servlet>

<servlet-name>LanguageCompleter</servlet-name> <servlet name>LanguageCompleter</servlet name> <servlet-class>

coreservlets.LanguageCompleter </servlet-class>

</servlet class> </servlet>

<servlet-mapping>

<servlet-name>LanguageCompleter</servlet-name> <servlet name>LanguageCompleter</servlet name> <url-pattern>/languages</url-pattern>

(12)

Ajax.Autocompleter Example:

Results

25

Autocompleter Options

(13)

Autocompleter Options

• Idea

–

Autocompleter.Local and Ajax.Autocompleter accept an

options array as the fourth argument

• new Ajax Autocompleter(fieldID divID url

new Ajax.Autocompleter(fieldID, divID, url,

{ opt1: ..., opt2: ..., ... });

• Legal properties for both classes

–

autoSelect (default: false)

• Should value automatically be inserted into textfield if

there is only one matching choice?

y

g

–

frequency (default: 0.4)

• Interval in seconds between attempts to autocomplete

i Ch

(d f lt 1)

–

minChars (default: 1)

• The number of characters before autocompletion kicks in

27

Autocompleter Options (Continued)

• Options for Autocompleter.Local

h i

(d f l 10)

–

choices (default 10)

• Maximum number of entries to display

–

partialSearch (default true)

• Should match be made at beginning of any word?

False means to match beginning of first word only.

–

partialChars (default 2)

• Number of characters before partial search kicks in. When

number of chars is greater or equal to minChars but less

than partialChars, you get a non-partial search (first word).

f llSearch (defa lt false)

–

fullSearch (default false)

• Should match be anywhere? False means to match only at

the beginning of each candidate.

selector (default: function that searches array)

–

selector (default: function that searches array)

• Function that does real work of doing match and building

(14)

Autocompleter Options (Continued)

• Options for Ajax.Autocompleter

i di

(d f l

)

–

indicator (default: none)

• Id of element that should be shown while waiting for server

result, then hidden again

N

(d f lt

f t tfi ld)

–

paramName (default: name of textfield)

• parameter name sent to server (parameter value is

textfield value, of course)

t

(d f lt

t )

–

parameters (default: empty)

• Extra string sent to server (fixed parameters)

–

tokens (default: empty)

• Array of delimeters: each entry outside delimeters is

autocompleted separately

–

afterUpdateElement (default: none)

• Function to run when user makes choice. Lets you

respond automatically to selections.

29

Autocompleter Options Example:

JavaScript

new Autocompleter Local("langField1", "langMenu1", new Autocompleter.Local( langField1 , langMenu1 ,

langArray);

new Ajax.Autocompleter("langField2", "langMenu2", "languages");languages );

new Ajax.Autocompleter("langField3", "langMenu3", "languages-slow",

{ indicator: "indicatorRegion",

{ g ,

paramName: "langPrefix"}); };

(15)

Autocompleter Options Example:

HTML

<fieldset>

<legend>Ajax Autocomplete with Indicator</legend> <legend>Ajax.Autocomplete with Indicator</legend> <form action="#">

<span id="indicatorRegion" style="display:none;"> <img src="images/busy-indicator.gif"/>g g y g

Loading... </span><br/>

<input type="text" id="langField3" name="bad-name"/>

<input type="button" value="Search on Language" onclick="googleSearch('langField3')"/><br/>

<di id "l M 3" l " t l t "></di >

<div id="langMenu3" class="autocomplete"></div> </form>

</fieldset>

31

Autocompleter Options Example:

Java

public class SlowLanguageCompleter

extends LanguageCompleter {

public void doGet(HttpServletRequest request,

HttpServletResponse response)

throws ServletException, IOException {

try { Thread.sleep(2000);

} catch(InterruptedException ie) {}

super.doGet(request, response);

}

(16)

Autocompleter Options Example:

web xml

web.xml

<servlet>

<servlet-name>SlowLanguageCompleter</servlet-name> <servlet name>SlowLanguageCompleter</servlet name> <servlet-class>

coreservlets.SlowLanguageCompleter </servlet-class>

</servlet class> </servlet>

<servlet-mapping>

<servlet-name>SlowLanguageCompleter</servlet-name> <servlet name>SlowLanguageCompleter</servlet name> <url-pattern>/languages-slow</url-pattern>

</servlet-mapping>

33

Autocompleter Options Example:

Results

(17)

In-Place Editors

• Idea

Text that you can click on edit and send to server

–

Text that you can click on, edit, and send to server

–

Text is highlighted when mouse over it

–

Text passed to server as “value” request parameter

• Text shown as “Saving ” while waiting for server

• Text shown as Saving... while waiting for server

–

Value returned from server is new textual value

• Might not be exactly what user entered

• Basics

Basics

–

new Ajax.InPlaceEditor("id-of-element", "url");

– Click on text to get editable textfield

–

new Ajax.InPlaceCollectionEditor

("id-of-element", "url"

{ collection: ["Option1", ... "OptionN"]});

– Click on text to get select box of options

–

Documentation

(18)

InPlaceEditor Example

• JavaScript

new Ajax.InPlaceEditor("element-to-edit", "show-value.jsp"); };

• HTML

<h2 id="element-to-edit">Here is Some Text</h2>

• JSP

<% try { Thread.sleep(2000);

} t h(I t t dE ti i ) {}

} catch(InterruptedException ie) {} %>You sent "${param.value}"

37

InPlaceEditor Example: Results

(19)

InPlaceCollectionEditor Example

• JavaScript

i d l d f ti () {

new Ajax.InPlaceEditor("element-to-edit", "show-value.jsp"); new Ajax.InPlaceCollectionEditor

new Ajax.InPlaceCollectionEditor ("flyer-status", "show-value.jsp",

{ collection: ["Silver", "Gold", "Platinum", "Wood", "Hay", "Stubble"]}); };

• HTML

<h2>Frequent Flyer Status:

<span id="flyer-status">Silver</span></h2>

• JSP

<% try { Thread.sleep(2000); y { p( )

} catch(InterruptedException ie) {} %>You sent "${param.value}"

39

InPlaceCollectionEditor Example:

Results

(20)

In-Place Editor Options:

Basic Options

• okButton (default: true)

–

Should you use "ok" button? Often set to false.

• okText (default: "ok")

T

f

fi

i

b

–

Text of confirmation button

• cancelLink (default: true)

Should you have "cancel" link?

–

Should you have cancel link?

• savingText (default "Saving...")

–

Text to show while waiting for server response

• clickToEditText (default: "Click to edit")

–

Text to show in tooltip when mouse hovers over text

p

• paramName (default: "value")

–

Request parameter name

41

In-Place Editor Options:

Ajax Request Options

Ajax.Request Options

• Idea

–

You can use ajaxOptions to specify an options object that

gets passed to the underlying Ajax.Request object

• new Ajax InPlaceEditor("id" "url" { ajaxOptions: { blah });

new Ajax.InPlaceEditor( id , url , { ajaxOptions: { blah });

• For {blah} above, you can use all of the same options as

discussed in the earlier section on the Prototype Ajax

libraries

• Most important usage: extra parameters

–

You are editing a first name, but what customer id does

that first name go with?

• var params = { param1: $("div-id").innerHTML,

param2: $F("textfield-id")};

p

(

)}

• var options = { parameters: params }

• new Ajax.InPlaceEditor("id", "url", { ajaxOptions: options });

(21)

In-Place Editor Options:

Collection Options

• collection

–

Array of choices

• loadCollectionURL

URL h

J

S i

f h i

–

URL that returns JavaScript array of choices

• loadCollectionText

Text to show while waiting for server to send array of

–

Text to show while waiting for server to send array of

choices

43

In-Place Editor Options:

Styling Options

• highlightColor (default: pale yellow)

–

Color to show when mouse is over and when result first

comes back from server

• highlightendColor (default: white)

–

Color to show temporarily when hightlighting finishes

• hoverClassName, formClassName,

hoverClassName, formClassName,

loadingClassName, savingClassName

• (defaults: none, form",

"inplaceeditor-l di " "i "inplaceeditor-l

dit

i ")

loading", "inplaceeditor-saving")

–

CSS name of elements at different stages

• formID

formID

(22)

In-Place Editor Options:

Callback Options

• onEnterHover

–

Defaults to setting background color

• onLeaveHover

D f l

f di

b k

d

l

–

Defaults to fading out background color

• onEnterEditMode

• onFailure

–

Defaults to showing error message

• onComplete

–

This is often used when you are doing server-side

validation of values. You can check a custom header from

the server and show error message if needed.

• onLeaveEditMode

45

Advanced Example: JavaScript

window.onload = function() { var options = {

var options { okButton: false,

clickToEditText: "Click to update your info" };

new Ajax.InPlaceEditor("firstName",

"update-firstName",

options);

new Ajax InPlaceEditor("lastName" new Ajax.InPlaceEditor( lastName ,

"update-lastName",

options);

new Ajax.InPlaceEditor("email", j ( ,

"update-email",

options);

new Ajax.InPlaceEditor("flyerNum",

" d t fl N "

"update-flyerNum",

options);

};

(23)

Advanced Example:

Servlet for Initial Page

public class ShowTraveler extends HttpServlet { public void doGet(HttpServletRequest request,

p p q q

HttpServletResponse response) throws ServletException, IOException {

response.setHeader("Cache-Control", "no-cache"); response.setHeader("Pragma", "no-cache");

response.setHeader( Pragma , no cache ); HttpSession session = request.getSession(); Traveler traveler =

(Traveler)session.getAttribute("traveler"); if (traveler == null) {

if (traveler == null) { traveler = new Traveler();

session.setAttribute("traveler", traveler); }

String outputPage =

"/WEB-INF/results/show-traveler.jsp"; RequestDispatcher dispatcher =

request.getRequestDispatcher(outputPage); dispatcher.include(request, response); } } 47

Advanced Example:

JSP for Initial Page

...

<ul style="font-size: 18px">

<ul style font size: 18px >

<li>First name: <span id="firstName">${traveler.firstName}</span> </li> <li>Last name: <span id="lastName">${traveler.lastName}</span> </li> <li>Email address: <li>Email address: <span id="email">${traveler.email}</span> </li>

<li>Frequent Flyer Number:

<span id="flyerNum">${traveler.flyerNum}</span> </li>

(24)

Advanced Example:

Helper Class for Initial Page

public class Traveler implements Serializable { private String firstName = "Joe";

p g ;

private String lastName = "Traveler"; private String email = "[email protected]"; private String flyerNum = "a1234";

public Traveler(String firstName, String lastName, String email, String flyerNum) { setFirstName(firstName);

setLastName(lastName); setEmail(email);

setFlyerNum(flyerNum); }

}

public Traveler () {}

// Standard getters and setters }

49

Advanced Example:

Initial Page: Results

(25)

Advanced Example:

Servlets for Updating

• Purpose

–

These are the servlets specified earlier in the

Ajax.InPlaceEditor constructors

• update-firstName update-lastName update-email

update firstName, update lastName, update email,

update-flyerNum

• Behavior

–

They look up the session, get a Traveler object from the

session, then store first name, last name, etc. in that object

–

They also have a delay to simulate use on a loaded

network

• This lets you see "Saving..." message while waiting for

server update

51

Advanced Example:

Servlets for Updating (Parent)

public abstract class UpdateTraveler extends HttpServlet {

public void doPost(HttpServletRequest request, public void doPost(HttpServletRequest request,

HttpServletResponse response) throws ServletException, IOException {

response.setHeader("Cache-Control", "no-cache");p ( , )

response.setHeader("Pragma", "no-cache"); HttpSession session = request.getSession(); Traveler traveler =

(Traveler)session.getAttribute("traveler"); if (traveler == null) {

traveler = new Traveler();

i tAtt ib t ("t l " t l )

(26)

Advanced Example:

Servlets for Updating (Parent Cont )

Servlets for Updating (Parent, Cont.)

String newVal = request.getParameter("value");

if ((newVal != null) && !(newVal trim() equals(""))) {

if ((newVal ! null) && !(newVal.trim().equals( ))) {

doUpdate(traveler, newVal); }

PrintWriter out = response.getWriter();p g ()

try { Thread.sleep(2000);

} catch(InterruptedException ie) {} out.print(getResult(traveler)); }

public abstract void doUpdate(Traveler traveler,

St i V l)

String newVal);

public abstract String getResult(Traveler traveler); }

53

Advanced Example:

Servlets for Updating (First Name)

public class UpdateFirstName extends UpdateTraveler { public void doUpdate(Traveler traveler,

public void doUpdate(Traveler traveler, String newVal) { traveler.setFirstName(newVal);

} }

public String getResult(Traveler traveler) { return(traveler.getFirstName());