Hosting sponsored by:
API: Page
Filename:
fwpPage_modes.ctyp
Released With:
5.1.0
Current Version:
1.0.1
Status: Active
Min Lasso Tested: 8.1.0
Max Lasso Tested: 8.5.3
Related:
Still don't get it?
Check out the talk list archives, or join and ask your questions.
Documentation Error or Request?
Email documentation corrections or comments
API Reference
fwp_pageModes (Type)
Description
Contains instance variables which govern various page display modes.
Syntax
$fw_pageModes->enableSomething; $fw_pageModes->disableSomething; if: $fw_pageModes->'useSomething';
... do something ...
/if;
Parameters & Member Tags
Instance Variables:
->'useSetCSS' (boolean) : When true, /_pbLibs/fwpPage_setCSS.lgc is included inside the <head> section of the page. Refer to fwpPage_setCSS.
->'useJSPerPage' (boolean) : When true, a conditional in /_pbLibs/fwpPage_templateHead.lgc will include a file named pageName.js in the template <head> section.
->'usePageStrings' (boolean) : When true, the templateLoader will call the $fw_pageStrings->getStringsForPage tag to retrieve records from the multi-view string data table(s) to populate the page. Refer to fwp_pageStrings.
->'useBlockTemplates' (boolean) : When true, the page assembly blockLoader will load block files beginning with blockTemplate and including the name of the block such as blockTemplate_main.lgc and blockTemplate_main.dsp.
->'useRepeatBlocks' (boolean) : When true, the page assembly blockLoader will load block files beginning with repeatLogic, repeatAbove, and repeatBelow and the name of the block such as repeatLogic_left.lgc and repeatAbove_main.dsp. Which blocks are to include repeating files is determined by an array of block names in 'repeatLogicBlocks', 'repeatAboveBlocks', and 'repeatBelowBlocks'.
->'useMultiLanguageBlocks' (boolean) : When true, the page assembly blockLoader will load display block files which include the current value of $fw_client->'language' such as pageName_main_en-us.dsp. This is not applied to logic files, as they should be written to be language independent or language inclusive.
->'useAutoErrorDisplay' (boolean) : When true, the page assembly blockLoader will include the current contents of $fw_error->'errorMsg' at the end of the current display block. This is useful for quick prototyping, but may or may not be desirable for the final error display management of an application.
->'usePreventCache' (boolean) : When true, the fwpPage_init process and the /_pbLibs/fwpPage_templateHead.lgc file will add headers and meta tags to prevent the caching of the page by HTTP servers.
->'repeatLogicBlocks' (array) : the list of block names for which a repeatLogic_ file should be loaded if 'useRepeatBlocks' is set to true.
->'repeatAboveBlocks' (array) : the list of block names for which a repeatAbove_ file should be loaded if 'useRepeatBlocks' is set to true.
->'repeatBelowBlocks' (array) : the list of block names for which a repeatBelow_ file should be loaded if 'useRepeatBlocks' is set to true.
Member Tags:
->enableSetCSS = sets ->'useSetCSS' to true.
->disableSetCSS = sets ->'useSetCSS' to false.
->enableJScripts = sets ->'useJScripts' to true.
->disableJScripts = sets ->'useJScripts' to false.
->enableJSPerPage = sets ->'useJSPerPage' to true.
->disableJSPerPage = sets ->'useJSPerPage' to false.
->enablePageStrings = sets ->'usePageStrings' to true.
->disablePageStrings = sets ->'usePageStrings' to false.
->enableBlockTemplates = sets ->'useBlockTemplates' to true.
->disableBlockTemplates = sets ->'useBlockTemplates' to false.
->enableRepeatBlocks = sets ->'useRepeatBlocks' to true.
->disableRepeatBlocks = sets ->'useRepeatBlocks' to false.
->enableMultiLanguageBlocks = sets ->'useMultiLanguageBlocks' to true.
->disableMultiLanguageBlocks = sets ->'useMultiLanguageBlocks' to false.
->enableAutoErrorDisplay = sets ->'useAutoErrorDisplay' to true.
->disableAutoErrorDisplay = sets ->'useAutoErrorDisplay' to false.
->enablePreventCache = sets ->'usePreventCache' to true.
->disablePreventCache = sets ->'usePreventCache' to false.
->setRepeatLogic = sets ->'repeatLogicBlocks' to the assigned array.
->setRepeatAbove = sets ->'repeatAboveBlocks' to the assigned array.
->setRepeatBelow = sets ->'repeatBelowBlocks' to the assigned array.
Source Code
New version available
Version 5.5 (zip)
Requirements
Lasso 8.5.
OS X, Linux, or Windows with Apache 2 or later. Read this for info about using IIS.
Contacts
Refer to pbTalk archives, or try LassoTalk. PageBlocks "lost" it's father, Greg Willits, on November 8, 2007. It has now been adopted by a "younger" family member, Nikolaj de Fine Licht
<?lassoscript
//............................................................................
//
// pageblocks: (c) 2002-2007 http://www.pageblocks.org/
//
//............................................................................
/*
{fileName= fwpPage_modes.ctyp }
{rsrcType= type }
{rsrcName= fwp_pageModes }
{rsrcHTTP= www.pageblocks.org/refc/fwp_pageModes }
{lassoVrsnMin= 8.1.0 }
{lassoVrsnMax= 8.5.3 }
{author= Greg Willits }
{authorEmail= subscribe to pbTalk at www.pageblocks.org/talk/ }
{authorHTTP= www.pageblocks.org }
{desc= consolidates a number of page assembly mode control
variables into a single object }
{maintvsrn= 1.1.2 }
{maintrelease= 5.3.0 }
{maintdate= 2008-03-05 }
{maintauthor= Nikolaj de Fine Licht }
{maintnotes= added usePrototype, useScriptaculous and useJquery }
{maintvsrn= 1.1.1 }
{maintrelease= 5.2.5 }
{maintdate= 2007-07-24 }
{maintauthor= Greg Willits }
{maintnotes= added useJSLibrary }
{maintvsrn= 1.1.0 }
{maintrelease= 5.2.0 }
{maintdate= 2007-06-20 }
{maintauthor= Greg Willits }
{maintnotes= removed useSetCSS and useJScripts }
{maintvsrn= 1.0.1 }
{maintrelease= 5.1.4 }
{maintdate= 2006-12-29 }
{maintauthor= Greg Willits }
{maintnotes= changed pageMapper to pageRouter }
{maintvsrn= 1.0 }
{maintrelease= 5.1.0 }
{maintdate= 2006-08-01 }
{maintauthor= Greg Willits }
{maintnotes= initial release }
*/
//............................................................................
define_type:'fwp_pageModes';
local('useJSPerPage' = boolean,
'useJSLibrary' = boolean,
'usePrototype' = boolean,
'useScriptaculous' = boolean,
'useJquery' = boolean,
'usePageStrings' = boolean,
'usePageRouter' = boolean,
'useBlockTemplates' = boolean,
'useRepeatBlocks' = boolean,
'useMultiLanguageBlocks' = boolean,
'useAppStringsDataTables' = boolean,
'useAutoErrorDisplay' = boolean,
'useAutoRestoreSession' = boolean,
'usePreventCache' = boolean
);
local('repeatLogicBlocks' = array,
'repeatAboveBlocks' = array,
'repeatBelowBlocks' = array
);
//: -
//============================================================================
define_tag:'enableJSPerPage';
(self->'useJSPerPage') = true;
/define_tag;
define_tag:'disableJSPerPage';
(self->'useJSPerPage') = false;
/define_tag;
//: -
//============================================================================
define_tag:'enableJSLibrary';
(self->'useJSLibrary') = true;
/define_tag;
define_tag:'disableJSLibrary';
(self->'useJSLibrary') = false;
/define_tag;
//: -
//============================================================================
define_tag('enablePrototype');
(self->'usePrototype') = true;
/define_tag;
define_tag('disablePrototype');
(self->'usePrototype') = false;
/define_tag;
//: -
//============================================================================
define_tag('enableScriptaculous');
(self->'useScriptaculous') = true;
/define_tag;
define_tag('disableScriptaculous');
(self->'useScriptaculous') = false;
/define_tag;
//: -
//============================================================================
define_tag('enableJquery');
(self->'useJquery') = true;
/define_tag;
define_tag('disableJquery');
(self->'useJquery') = false;
/define_tag;
//: -
//============================================================================
define_tag:'enablePageStrings';
(self->'usePageStrings') = true;
/define_tag;
define_tag:'disablePageStrings';
(self->'usePageStrings') = false;
/define_tag;
//: -
//============================================================================
define_tag:'enablePageRouter';
(self->'usePageRouter') = true;
/define_tag;
define_tag:'disablePageRouter';
(self->'usePageRouter') = false;
/define_tag;
//: -
//============================================================================
define_tag:'enableBlockTemplates';
(self->'useBlockTemplates') = true;
/define_tag;
define_tag:'disableBlockTemplates';
(self->'useBlockTemplates') = false;
/define_tag;
//: -
//============================================================================
define_tag:'enableRepeatBlocks';
(self->'useRepeatBlocks') = true;
/define_tag;
define_tag:'disableRepeatBlocks';
(self->'useRepeatBlocks') = false;
/define_tag;
define_tag:'setRepeatLogic',
-required = 'blockList', -type = array;
(self->'repeatLogicBlocks') = #blockList;
/define_tag;
define_tag:'setRepeatAbove',
-required = 'blockList', -type = array;
(self->'repeatAboveBlocks') = #blockList;
/define_tag;
define_tag:'setRepeatBelow',
-required = 'blockList', -type = array;
(self->'repeatBelowBlocks') = #blockList;
/define_tag;
//: -
//============================================================================
define_tag:'enableAutoErrorDisplay';
(self->'useAutoErrorDisplay') = true;
/define_tag;
define_tag:'disableAutoErrorDisplay';
(self->'useAutoErrorDisplay') = false;
/define_tag;
//: -
//============================================================================
define_tag:'enableAutoRestoreSession';
(self->'useAutoRestoreSession') = true;
/define_tag;
define_tag:'disableAutoRestoreSession';
(self->'useAutoRestoreSession') = false;
/define_tag;
//: -
//============================================================================
define_tag:'enableMultiLanguageBlocks';
(self->'useMultiLanguageBlocks') = true;
/define_tag;
define_tag:'disableMultiLanguageBlocks';
(self->'useMultiLanguageBlocks') = false;
/define_tag;
//: -
//============================================================================
define_tag:'enablePreventCache';
(self->'usePreventCache') = true;
/define_tag;
define_tag:'disablePreventCache';
(self->'usePreventCache') = false;
/define_tag;
/define_type;
?>
© 2002-2012, pageblocks.org