JavaScript DHTML/YUI Library/Browser History
Содержание
Integrating Browser History Manager with Server-side Pagination and Sorting
<source lang="html4strict">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Integrating Browser History Manager with Server-side Pagination and Sorting</title> <style type="text/css"> /*margin and padding on body element
can introduce errors in determining element position and are not recommended; we turn them off as a foundation for YUI CSS treatments. */
body {
margin:0; padding:0;
} </style> <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/fonts/fonts-min.css" /> <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/paginator/assets/skins/sam/paginator.css" /> <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/datatable/assets/skins/sam/datatable.css" /> <script type="text/javascript" src="yui_2.7.0b-lib/yahoo-dom-event/yahoo-dom-event.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/datasource/datasource-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/connection/connection-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/json/json-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/history/history-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/element/element-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/paginator/paginator-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/datatable/datatable-min.js"></script>
<style type="text/css">
/* custom styles for this example */
- yui-history-iframe {
position:absolute; top:0; left:0; width:1px; height:1px; /* avoid scrollbars */ visibility:hidden;
} </style>
</head> <body class=" yui-skin-sam">
Integrating Browser History Manager with Server-side Pagination and Sorting
This example combines server-side pagination and sorting with the Browser History Manager for the ability to bookmark states.
<iframe id="yui-history-iframe" src="yui_2.7.0b-assets/datatable-assets/html/blank.html"></iframe> <input id="yui-history-field" type="hidden">
<script type="text/javascript"> (function () {
// Create the DataSource
var myDataSource = new YAHOO.util.DataSource("yui_2.7.0b-assets/datatable-assets/php/json_proxy.php?");
myDataSource.responseType = YAHOO.util.DataSource.TYPE_JSON;
myDataSource.responseSchema = {
resultsList: "records",
fields: ["id","name","date","price"],
metaFields: {
totalRecords: "totalRecords",
paginationRecordOffset : "startIndex",
paginationRowsPerPage : "pageSize",
sortKey: "sort",
sortDir: "dir"
}
};
// Create the Paginator
var myPaginator = new YAHOO.widget.Paginator({
containers : ["dt-pag-nav"],
template : "{PreviousPageLink} {CurrentPageReport} {NextPageLink} {RowsPerPageDropdown}",
pageReportTemplate : "Showing items {startIndex} - {endIndex} of {totalRecords}",
rowsPerPageOptions : [10,25,50,100]
});
// Define Columns
var myColumnDefs = [
{key:"id", label:"ID", sortable:true},
{key:"name", label:"Name", sortable:true},
{key:"date", label:"Date", sortable:true},
{key:"price", label:"Price", sortable:true}
];
// DataTable configurations
var myConfig = {
paginator : myPaginator,
dynamicData : true,
initialLoad : false
};
// Instantiate DataTable
var myDataTable = new YAHOO.widget.DataTable(
"bhmintegration", myColumnDefs, myDataSource, myConfig
);
// Show loading message while page is being rendered
myDataTable.showTableMessage(myDataTable.get("MSG_LOADING"), YAHOO.widget.DataTable.CLASS_LOADING);
// Add the instances to the YAHOO.example namespace for inspection
YAHOO.example.BHMIntegration = {
myPaginator : myPaginator,
myDataSource : myDataSource,
myDataTable : myDataTable
};
// Integrate with Browser History Manager
var History = YAHOO.util.History;
// Define a custom function to route sorting through the Browser History Manager
var handleSorting = function (oColumn) {
// Calculate next sort direction for given Column
var sDir = this.getColumnSortDir(oColumn);
// The next state will reflect the new sort values
// while preserving existing pagination rows-per-page
// As a best practice, a new sort will reset to page 0
var newState = generateRequest(0, oColumn.key, sDir, this.get("paginator").getRowsPerPage());
// Pass the state along to the Browser History Manager
History.navigate("myDataTable", newState);
};
myDataTable.sortColumn = handleSorting;
// Define a custom function to route pagination through the Browser History Manager
var handlePagination = function(state) {
// The next state will reflect the new pagination values
// while preserving existing sort values
// Note that the sort direction needs to be converted from DataTable format to server value
var sortedBy = this.get("sortedBy"),
newState = generateRequest(
state.recordOffset, sortedBy.key, sortedBy.dir, state.rowsPerPage
);
// Pass the state along to the Browser History Manager
History.navigate("myDataTable", newState);
};
// First we must unhook the built-in mechanism...
myPaginator.unsubscribe("changeRequest", myDataTable.onPaginatorChangeRequest);
// ...then we hook up our custom function
myPaginator.subscribe("changeRequest", handlePagination, myDataTable, true);
// Update payload data on the fly for tight integration with latest values from server
myDataTable.doBeforeLoadData = function(oRequest, oResponse, oPayload) {
var meta = oResponse.meta;
oPayload.totalRecords = meta.totalRecords || oPayload.totalRecords;
oPayload.pagination = {
rowsPerPage: meta.paginationRowsPerPage || 10,
recordOffset: meta.paginationRecordOffset || 0
};
oPayload.sortedBy = {
key: meta.sortKey || "id",
dir: (meta.sortDir) ? "yui-dt-" + meta.sortDir : "yui-dt-asc" // Convert from server value to DataTable format
};
return true;
};
// Returns a request string for consumption by the DataSource
var generateRequest = function(startIndex,sortKey,dir,results) {
startIndex = startIndex || 0;
sortKey = sortKey || "id";
dir = (dir) ? dir.substring(7) : "asc"; // Converts from DataTable format "yui-dt-[dir]" to server value "[dir]"
results = results || 10;
return "results="+results+"&startIndex="+startIndex+"&sort="+sortKey+"&dir="+dir;
};
// Called by Browser History Manager to trigger a new state
var handleHistoryNavigation = function (request) {
// Sends a new request to the DataSource
myDataSource.sendRequest(request,{
success : myDataTable.onDataReturnSetRows,
failure : myDataTable.onDataReturnSetRows,
scope : myDataTable,
argument : {} // Pass in container for population at runtime via doBeforeLoadData
});
};
// Calculate the first request
var initialRequest = History.getBookmarkedState("myDataTable") || // Passed in via URL
generateRequest(); // Get default values
// Register the module
History.register("myDataTable", initialRequest, handleHistoryNavigation);
// Render the first view
History.onReady(function() {
// Current state after BHM is initialized is the source of truth for what state to render
var currentState = History.getCurrentState("myDataTable");
handleHistoryNavigation(currentState);
});
// Initialize the Browser History Manager.
YAHOO.util.History.initialize("yui-history-field", "yui-history-iframe");
})(); </script>
</body>
</source>
<A href="http://www.wbex.ru/Code/JavaScriptDownload/yui_2.7.0b.zip">yui_2.7.0b.zip( 4,431 k)</a>
Use Browser History Manager to remember which months have been viewed and update it when the user presses the browser"s back/forward buttons.
<source lang="html4strict">
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Calendar Control</title> <style type="text/css"> /*margin and padding on body element
can introduce errors in determining element position and are not recommended; we turn them off as a foundation for YUI CSS treatments. */
body {
margin:0; padding:0;
} </style> <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/fonts/fonts-min.css" /> <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/calendar/assets/skins/sam/calendar.css" /> <script type="text/javascript" src="yui_2.7.0b-lib/yahoo-dom-event/yahoo-dom-event.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/calendar/calendar-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/history/history-min.js"></script>
</head> <body class=" yui-skin-sam">
Calendar Control
This example demonstrates how to use the Browser History Manager to remember which months have been viewed with the calendar widget and dynamically update it when the user presses the browser"s back/forward buttons.
<style>
- yui-history-iframe {
position:absolute; top:0; left:0; width:1px; height:1px; /* avoid scrollbars */ visibility:hidden;
} </style>
<iframe id="yui-history-iframe" src="yui_2.7.0b-assets/history-assets/blank.html"></iframe> <input id="yui-history-field" type="hidden">
<script> (function () {
// The initial month will be chosen in the following order:
//
// URL fragment identifier (it will be there if the user previously
// bookmarked the application in a specific state)
//
// or
//
// today"s corresponding month (default)
var today = new Date();
var defaultCalendarState = (today.getMonth() + 1) + "_" + today.getFullYear();
var bookmarkedCalendarState = YAHOO.util.History.getBookmarkedState("calendar");
var initialCalendarState = bookmarkedCalendarState || defaultCalendarState;
var calendar;
// Register our calendar module. Module registration MUST
// take place before calling YAHOO.util.History.initialize.
YAHOO.util.History.register("calendar", initialCalendarState, function (state) {
// This is called after calling YAHOO.util.History.navigate, or after the user
// has trigerred the back/forward button. We cannot discrminate between
// these two situations.
// Show the right month according to the "state" parameter:
calendar.cfg.setProperty("pagedate", state.replace("_", "/"));
calendar.render();
});
function handleCalendarBeforeRender () {
var calDate, newState, currentState;
calDate = calendar.cfg.getProperty("pageDate");
newState = (calDate.getMonth() + 1) + "_" + calDate.getFullYear();
try {
currentState = YAHOO.util.History.getCurrentState("calendar");
// The following test is crucial. Otherwise, we end up circling forever.
// Indeed, YAHOO.util.History.navigate will call the module onStateChange
// callback, which will call createCalendar, which will call calendar.render(),
// which will end up calling handleCalendarBeforeRender, and it keeps going
// from here...
if (newState !== currentState) {
YAHOO.util.History.navigate("calendar", newState);
}
} catch (e) {
calendar.cfg.setProperty("pagedate", newState.replace("_", "/"));
calendar.render();
}
}
function initCalendar (startDate) {
// Instantiate the calendar control...
calendar = new YAHOO.widget.Calendar("calendar", "calendarContainer", startDate);
calendar.beforeRenderEvent.subscribe(handleCalendarBeforeRender, calendar, true);
calendar.render();
}
// Use the Browser History Manager onReady method to instantiate the calendar widget.
YAHOO.util.History.onReady(function () {
var currentState;
// This is the tricky part... The onLoad event is fired when the user
// comes back to the page using the back button. In this case, the
// actual month that needs to be loaded corresponds to the last month
// visited before leaving the page, and not the initial month. This can
// be retrieved using getCurrentState:
currentState = YAHOO.util.History.getCurrentState("calendar");
initCalendar({ pagedate: currentState.replace("_", "/") });
});
// Initialize the browser history management library.
try {
YAHOO.util.History.initialize("yui-history-field", "yui-history-iframe");
} catch (e) {
// The only exception that gets thrown here is when the browser is
// not supported (Opera, or not A-grade) Degrade gracefully.
initCalendar({ pagedate: initialCalendarState.replace("_", "/") });
}
})(); </script>
</body> </html>
</source>
<A href="http://www.wbex.ru/Code/JavaScriptDownload/yui_2.7.0b.zip">yui_2.7.0b.zip( 4,431 k)</a>
Use Browser History Manager to remember which tabs have been visited
<source lang="html4strict">
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>TabView Control</title> <style type="text/css"> /*margin and padding on body element
can introduce errors in determining element position and are not recommended; we turn them off as a foundation for YUI CSS treatments. */
body {
margin:0; padding:0;
} </style> <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/fonts/fonts-min.css" /> <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/tabview/assets/skins/sam/tabview.css" /> <script type="text/javascript" src="yui_2.7.0b-lib/yahoo-dom-event/yahoo-dom-event.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/element/element-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/tabview/tabview-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/history/history-min.js"></script>
</head> <body class=" yui-skin-sam">
TabView Control
This example demonstrates how to use the Browser History Manager to remember which tabs have been visited with the TabView widget and dynamically update it when the user presses the browser"s back/forward buttons.
<style>
- yui-history-iframe {
position:absolute; top:0; left:0; width:1px; height:1px; /* avoid scrollbars */ visibility:hidden;
}
- demo { margin-bottom:1em; }
</style>
<iframe id="yui-history-iframe" src="yui_2.7.0b-assets/history-assets/blank.html"></iframe> <input id="yui-history-field" type="hidden">
- <a href="#tab1">Tab One Label</a>
- <a href="#tab2">Tab Two Label</a>
- <a href="#tab3">Tab Three Label</a>
Tab One Content
Tab Two Content
Tab Three Content
<script> (function () {
// The initially selected tab will be chosen in the following order:
//
// URL fragment identifier (it will be there if the user previously
// bookmarked the application in a specific state)
//
// or
//
// "tab0" (default)
var bookmarkedTabViewState = YAHOO.util.History.getBookmarkedState("tabview");
var initialTabViewState = bookmarkedTabViewState || "tab0";
var tabView;
// Register our TabView module. Module registration MUST
// take place before calling YAHOO.util.History.initialize.
YAHOO.util.History.register("tabview", initialTabViewState, function (state) {
// This is called after calling YAHOO.util.History.navigate, or after the user
// has trigerred the back/forward button. We cannot discrminate between
// these two situations.
// "state" can be "tab0", "tab1" or "tab2".
// Select the right tab:
tabView.set("activeIndex", state.substr(3));
});
function handleTabViewActiveTabChange (e) {
var newState, currentState;
newState = "tab" + this.getTabIndex(e.newValue);
try {
currentState = YAHOO.util.History.getCurrentState("tabview");
// The following test is crucial. Otherwise, we end up circling forever.
// Indeed, YAHOO.util.History.navigate will call the module onStateChange
// callback, which will call tabView.set, which will call this handler
// and it keeps going from here...
if (newState != currentState) {
YAHOO.util.History.navigate("tabview", newState);
}
} catch (e) {
tabView.set("activeIndex", newState.substr(3));
}
}
function initTabView () {
// Instantiate the TabView control...
tabView = new YAHOO.widget.TabView("demo");
tabView.addListener("activeTabChange", handleTabViewActiveTabChange);
}
// Use the Browser History Manager onReady method to instantiate the TabView widget.
YAHOO.util.History.onReady(function () {
var currentState;
initTabView();
// This is the tricky part... The onLoad event is fired when the user
// comes back to the page using the back button. In this case, the
// actual tab that needs to be selected corresponds to the last tab
// selected before leaving the page, and not the initially selected tab.
// This can be retrieved using getCurrentState:
currentState = YAHOO.util.History.getCurrentState("tabview");
tabView.set("activeIndex", currentState.substr(3));
});
// Initialize the browser history management library.
try {
YAHOO.util.History.initialize("yui-history-field", "yui-history-iframe");
} catch (e) {
// The only exception that gets thrown here is when the browser is
// not supported (Opera, or not A-grade) Degrade gracefully.
initTabView();
}
})(); </script>
</body> </html>
</source>
<A href="http://www.wbex.ru/Code/JavaScriptDownload/yui_2.7.0b.zip">yui_2.7.0b.zip( 4,431 k)</a>
Use the Browser History Manager with several different modules.
<source lang="html4strict">
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Multiple Modules</title> <style type="text/css"> /*margin and padding on body element
can introduce errors in determining element position and are not recommended; we turn them off as a foundation for YUI CSS treatments. */
body {
margin:0; padding:0;
} </style> <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/fonts/fonts-min.css" /> <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/calendar/assets/skins/sam/calendar.css" /> <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/tabview/assets/skins/sam/tabview.css" /> <script type="text/javascript" src="yui_2.7.0b-lib/yahoo-dom-event/yahoo-dom-event.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/element/element-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/calendar/calendar-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/tabview/tabview-min.js"></script> <script type="text/javascript" src="yui_2.7.0b-lib/history/history-min.js"></script>
</head> <body class=" yui-skin-sam">
Multiple Modules
This example demonstrates how to use the Browser History Manager with several different modules. Working with several modules is not different from working with a single module. All the modules have to be registered separately, and each module has its own initial state and callback.
<style>
- yui-history-iframe {
position:absolute; top:0; left:0; width:1px; height:1px; /* avoid scrollbars */ visibility:hidden;
}
- demo { margin-bottom:1em; }
</style>
<iframe id="yui-history-iframe" src="yui_2.7.0b-assets/history-assets/blank.html"></iframe> <input id="yui-history-field" type="hidden">
- <a href="#tab1">Tab One Label</a>
- <a href="#tab2">Tab Two Label</a>
- <a href="#tab3">Tab Three Label</a>
Tab Two Content
<script> (function () {
// The initial month will be chosen in the following order:
//
// URL fragment identifier (it will be there if the user previously
// bookmarked the application in a specific state)
//
// or
//
// today"s corresponding month (default)
var today = new Date();
var defaultCalendarState = (today.getMonth() + 1) + "_" + today.getFullYear();
var bookmarkedCalendarState = YAHOO.util.History.getBookmarkedState("calendar");
var initialCalendarState = bookmarkedCalendarState || defaultCalendarState;
// The initially selected tab will be chosen in the following order:
//
// URL fragment identifier (it will be there if the user previously
// bookmarked the application in a specific state)
//
// or
//
// "tab0" (default)
var bookmarkedTabViewState = YAHOO.util.History.getBookmarkedState("tabview");
var initialTabViewState = bookmarkedTabViewState || "tab0";
var calendar;
var tabView;
// Register our calendar module. Module registration MUST
// take place before calling YAHOO.util.History.initialize.
YAHOO.util.History.register("calendar", initialCalendarState, function (state) {
// This is called after calling YAHOO.util.History.navigate, or after the user
// has trigerred the back/forward button. We cannot discrminate between
// these two situations.
// Show the right month according to the "state" parameter:
calendar.cfg.setProperty("pagedate", state.replace("_", "/"));
calendar.render();
});
// Register our TabView module. Module registration MUST
// take place before calling YAHOO.util.History.initialize.
YAHOO.util.History.register("tabview", initialTabViewState, function (state) {
// This is called after calling YAHOO.util.History.navigate, or after the user
// has trigerred the back/forward button. We cannot discrminate between
// these two situations.
// "state" can be "tab0", "tab1" or "tab2".
// Select the right tab:
tabView.set("activeIndex", state.substr(3));
});
function handleCalendarBeforeRender () {
var calDate, newState, currentState;
calDate = calendar.cfg.getProperty("pageDate");
newState = (calDate.getMonth() + 1) + "_" + calDate.getFullYear();
try {
currentState = YAHOO.util.History.getCurrentState("calendar");
// The following test is crucial. Otherwise, we end up circling forever.
// Indeed, YAHOO.util.History.navigate will call the module onStateChange
// callback, which will call createCalendar, which will call calendar.render(),
// which will end up calling handleCalendarBeforeRender, and it keeps going
// from here...
if (newState !== currentState) {
YAHOO.util.History.navigate("calendar", newState);
}
} catch (e) {
calendar.cfg.setProperty("pagedate", newState.replace("_", "/"));
calendar.render();
}
}
function initCalendar (startDate) {
// Instantiate the calendar control...
calendar = new YAHOO.widget.Calendar("calendar", "calendarContainer", startDate);
calendar.beforeRenderEvent.subscribe(handleCalendarBeforeRender, calendar, true);
calendar.render();
}
function handleTabViewActiveTabChange (e) {
var newState, currentState;
newState = "tab" + this.getTabIndex(e.newValue);
try {
currentState = YAHOO.util.History.getCurrentState("tabview");
// The following test is crucial. Otherwise, we end up circling forever.
// Indeed, YAHOO.util.History.navigate will call the module onStateChange
// callback, which will call tabView.set, which will call this handler
// and it keeps going from here...
if (newState != currentState) {
YAHOO.util.History.navigate("tabview", newState);
}
} catch (e) {
tabView.set("activeIndex", newState.substr(3));
}
}
function initTabView () {
// Instantiate the TabView control...
tabView = new YAHOO.widget.TabView("demo");
tabView.addListener("activeTabChange", handleTabViewActiveTabChange);
}
// Use the Browser History Manager onReady method to initialize the application.
YAHOO.util.History.onReady(function () {
var currentState;
currentState = YAHOO.util.History.getCurrentState("calendar");
initCalendar({ pagedate: currentState.replace("_", "/") });
initTabView();
currentState = YAHOO.util.History.getCurrentState("tabview");
tabView.set("activeIndex", currentState.substr(3));
});
// Initialize the browser history management library.
try {
YAHOO.util.History.initialize("yui-history-field", "yui-history-iframe");
} catch (e) {
// The only exception that gets thrown here is when the browser is
// not supported (Opera, or not A-grade) Degrade gracefully.
initCalendar({ pagedate: initialCalendarState.replace("_", "/") });
initTabView();
}
})(); </script>
</body> </html>
</source>
<A href="http://www.wbex.ru/Code/JavaScriptDownload/yui_2.7.0b.zip">yui_2.7.0b.zip( 4,431 k)</a>
