Docs For Class atkPage
Atk API home Class tree Element index

Todo list

Packages: » atk Classes: skel- » atkAppSuite utils » atkAbstractFrame » atkActionListener » atkClassFinder » atkClassLoader » atkDataHolder » atkDebugger » atkDirectoryTraverser » atkEventLog » atkFileUtils » atkFrame » atkFrameSet » atkIpUtils » atkJSON » atkMail » atkMailer » atkMessageQueue » atkmlsplitter » atkNavigator » atkRootFrameset » atkSelector » atkString » atkStringParser » atkTableRenderer » atkTableRendererGrouped » atkTextMarker » atkTmpFile » atkTriggerListener » atkYAML » atkZip » browserInfo » listenerTest » simplevisitor » testNode » test_atkactionlistener » test_atkclassloader » test_atkcolumnconfig » test_atkDirectoryTraverser » test_atklistattribute » test_atkStringParser » test_atkTextMarker general » atkConfig » atkController » atkDataNode » atkErrorHandlerBase » atkFileEditor » atkLanguage » atkMailErrorHandler » atkMetaNode » atkMockNode » atkNode » atkNodeValidator » atkSessionStore » atkTreeNode » atkWizardBase » atkZendPlatformErrorHandler » clsTbsDataSource » clsTbsLocator » clsTinyButStrong » clsTinyButStrongOOo » FCKeditor » getSupportedLanguagesCollector » layout » node » sql_whereclause_blacklist_checker » test » tree » triggerNode fixture » atkAbstractFixtureLoader » atkFixtureManager » atkPHPFixtureLoader » atkYAMLFixtureLoader testcases » atkAbstractSearchHandler » DateAttributeWrapper » dummyTagAttribute » Stub_atkNew » test_atkattributeedithandler » test_atkBoolAttribute » test_atkCalculatorAttribute » test_atkcolorpickerattribute » test_atkDataGrid » test_atkdatanode » test_atkDateAttribute » test_atkFileAttribute » test_atkfrontcontroller » test_atkiputils » test_atkManyToOneRelation » test_atknode » test_atkRelation » test_atktagattribute » test_atkwizard » test_tabs » uriPartsFrontControllerMock ui » atkActionBoxBuilder » atkDialog » atkIndexPage » atkOutput » atkPage » atkPageBuilder » atkTheme » atkThemeCompiler » atkUI handlers » atkActionHandler » atkAddHandler » atkAddOrCopyHandler » atkAdminHandler » atkAttributeEditHandler » atkCopyHandler » atkDeleteHandler » atkDocumentHandler » atkEditCopyHandler » atkEditHandler » atkExportHandler » atkFeedbackHandler » atkFileExport » atkImportHandler » atkMultiSelectHandler » atkMultiUpdatehandler » atkSaveHandler » atkSearchHandler » atkSelectHandler » atkSmartSearchHandler » atkUpdatehandler » atkViewEditBase » atkViewHandler » atkXmlHandler » test_atkimporthandler attributes » atkAggregatedColumn » atkAttribute » atkBoolAttribute » atkCalculatorAttribute » atkCaptchaAttribute » atkColorPickerAttribute » atkCountryAttribute » atkCreatedByAttribute » atkCreateStampAttribute » atkCurrencyAttribute » atkDateAttribute » atkDateTimeAttribute » atkDocumentAttribute » atkDummyAttribute » atkDurationAttribute » atkEmailAttribute » atkExpressionAttribute » atkFckAttribute » atkFieldSet » atkFileAttribute » atkFileWriterAttribute » atkFlagAttribute » atkFormatAttribute » atkFuzzySearchAttribute » atkHtmlAttribute » atkIpAttribute » atkListAttribute » atkLiveTextPreview » atkMlAttribute » atkMlHtmlAttribute » atkMlNumberAttribute » atkMlSelectorAttribute » atkMlTextAttribute » atkMlWrapper » atkMultipleFileAttribute » atkMultiSelectAttribute » atkNumberAttribute » atkParserAttribute » atkPasswordAttribute » atkProfileAttribute » atkRadioAttribute » atkRadioDetailsAttribute » atkRowCounter » atkStateAttribute » atkTabbedPane » atkTagAttribute » atkTextAttribute » atkTimeAttribute » atkTimeZoneAttribute » atkToolbar » atkUpdatedByAttribute » atkUpdateStampAttribute » atkUrlAttribute » atkWeekdayAttribute » atkWysiwygAttribute » test_atkattribute » test_atkmultiselectattribute » test_atktextattribute datatypes » atkArrayDt » atkDataType » atkStringDt » atkTime subpackage » atkAttributeTestCase security » atkBajusEncryption » atkBase64Encryption » atkEncryption » atkMockSecurityManager » atkOpenSSLEncryption » atkSecurityListener » atkSecurityManager » atkUrlVault » auth_config » auth_db » auth_imap » auth_interface » auth_ldap » auth_none » auth_pop3 » auth_server » auth_sspi » test_atkMockSecurityManager » test_atkUrlVault cache » atkCache » atkCache_apc » atkCache_eaccelerator » atkCache_file » atkCache_memcache » atkCache_var » atkCache_xcache » atkCache_zp_disk » atkCache_zp_output » atkCache_zp_shm » test_atkcache_apc » test_atkcache_eaccelerator » test_atkcache_file » test_atkcache_memcache » test_atkcache_var » test_atkcache_xcache » test_atkcache_zp_disk » test_atkcache_zp_output » test_atkcache_zp_shm test » ArrayHtmlReporter » ArrayTextReporter » atkCacheTestCase » atkPHPUnitTestCaseCollector » atkPluginTestCase » atkSimpleTestTestCaseCollector » atkTestCase » atkTestCaseCollector » atkTestReporter » atkTestSuite » atkTestTraverser » test_atkMockNode » test_atktestcase » test_atktools » Test_DbConfigs » test_sql_whereclause_blacklist_checker » test_tabsecurity » test_triggers db » atkClusterDb » atkClusterDDL » atkClusterQuery » atkDb » atkDDL » atkMockDb » atkMockDDL » atkMockQuery » atkMsSqlDb » atkMsSqlDDL » atkMssqlQuery » atkMysqlDb » atkMysqlDDL » atkMysqliDb » atkMysqliDDL » atkMysqliQuery » atkMysqlQuery » atkOci8Db » atkOci8DDL » atkOci8Query » atkOci9Db » atkOci9DDL » atkOci9Query » atkOci805Db » atkOci805Query » atkPgsqlDb » atkPgsqlDDL » atkPgsqlQuery » atkQuery » test_atkdb recordlist » atkColumnConfig » atkCSVRecordList » atkCustomRecordList » atkExcelCSVRecordList » atkHTMLRecordList » atkPrintableRecordList » atkRecordList » atkRecordlistCache » atkTotalizer console » atkConsoleController menu » atkcookmenu » atkDhtmlMenu » atkDropdownMenu » atkFramesMenu » atkMenu » atkmenuinterface » atkModernMenu » atkOutlookMenu » atkPlainMenu datagrid » atkDataGrid » atkDGComponent » atkDGEditControl » atkDGEvent » atkDGIndex » atkDGLimit » atkDGList » atkDGNoRecordsFound » atkDGPaginator » atkDGRenderer » atkDGSummary lock » atkDbLock » atkLock filters » atkDistinctFilter » atkFilter » atkGroupByFilter document » atkDocumentWriter » atkDocxWriter » atkOpenDocumentWriter meta » atkDutchMetaGrammar » atkMetaAttributeModifier » atkMetaCompiler » atkMetaGrammar » atkMetaPolicy » mod_meta relations » atkExtendableShuttleRelation » atkManyBoolRelation » atkManyToManyListRelation » atkManyToManyRelation » atkManyToManySelectRelation » atkManyToOneRelation » atkManyToOneTreeRelation » atkMatrixRelation » atkOneToManyRelation » atkOneToManyRelationSessionGridHandler » atkOneToOneRelation » atkRelation » atkSecureRelation » atkShuttleControl » atkShuttleFilter » atkShuttleRelation front » atkFrontController » atkFrontControllerBridge keyboard » atkKeyboard meta-relations » atkMetaExtendableShuttleRelation » atkMetaManyBoolRelation » atkMetaManyToManyListRelation » atkMetaManyToManySelectRelation » atkMetaManyToOneRelation » atkMetaOneToManyRelation » atkMetaOneToOneRelation » atkMetaShuttleRelation modules » atkModule » mod_test interface » atkServer » atkSoapServer session » atkSessionManager » atkState wizard » atkWizard » AtkWizardActionLoader » atkWizardPanel attribute » test_atkcurrencyattribute » test_atknumberattribute
Interfaces: datagrid » atkDGListener interface » atkServerInterface
Files: general » adodb-time.inc.php » atknodetools.inc » atktools.inc » atktreetools.inc » basexml.php » class.atkconfig.inc » class.atkcontroller.inc » class.atkdatanode.inc » class.atkerrorhandlerbase.inc » class.atkfileeditor.inc » class.atklanguage.inc » class.atkmailerrorhandler.inc » class.atkmetanode.inc » class.atkmocknode.inc » class.atknode.inc » class.atknodevalidator.inc » class.atksessionstore.inc » class.atktreenode.inc » class.atkwizardbase.inc » class.atkzendplatformerrorhandler.inc » class.layout.inc » class.nodename.inc » class.sql_whereclause_blacklist_checker.inc » class.test.inc » class.test_sql_whereclause_blacklist_checker.inc » class.test_triggers.inc » commands.php » config.modules.inc » config.php » connector.php » console.php » db2yaml.php » defaultconfig.inc.php » fckeditor.php » fckeditor_php4.php » fckeditor_php5.php » io.php » module.inc » phpcompat.php » server.php » spellchecker.php » table2yaml.php » tbsooo_class.php » tbs_class.php » upload.php » util.php » version.inc attribute » class.test_atkcurrencyattribute.inc » class.test_atknumberattribute.inc attributes » class.atkaggregatedcolumn.inc » class.atkattribute.inc » class.atkboolattribute.inc » class.atkcalculatorattribute.inc » class.atkcaptchaattribute.inc » class.atkcolorpickerattribute.inc » class.atkcountryattribute.inc » class.atkcreatedbyattribute.inc » class.atkcreatestampattribute.inc » class.atkcurrencyattribute.inc » class.atkdateattribute.inc » class.atkdatetimeattribute.inc » class.atkdocumentattribute.inc » class.atkdummyattribute.inc » class.atkdurationattribute.inc » class.atkemailattribute.inc » class.atkexpressionattribute.inc » class.atkfckattribute.inc » class.atkfieldset.inc » class.atkfileattribute.inc » class.atkfilewriterattribute.inc » class.atkflagattribute.inc » class.atkformatattribute.inc » class.atkfuzzysearchattribute.inc » class.atkhtmlattribute.inc » class.atkipattribute.inc » class.atklistattribute.inc » class.atklivetextpreview.inc » class.atkmlattribute.inc » class.atkmlhtmlattribute.inc » class.atkmlnumberattribute.inc » class.atkmlselectorattribute.inc » class.atkmltextattribute.inc » class.atkmlwrapper.inc » class.atkmultiplefileattribute.inc » class.atkmultiselectattribute.inc » class.atknumberattribute.inc » class.atkparserattribute.inc » class.atkpasswordattribute.inc » class.atkprofileattribute.inc » class.atkradioattribute.inc » class.atkradiodetailsattribute.inc » class.atkrowcounter.inc » class.atkstateattribute.inc » class.atktabbedpane.inc » class.atktagattribute.inc » class.atktextattribute.inc » class.atktimeattribute.inc » class.atktimezoneattribute.inc » class.atktoolbar.inc » class.atkupdatedbyattribute.inc » class.atkupdatestampattribute.inc » class.atkurlattribute.inc » class.atkweekdayattribute.inc » class.atkwysiwygattribute.inc » class.test_atkattribute.inc » class.test_atkmultiselectattribute.inc » class.test_atktextattribute.inc attributes-- » property_accessor.php cache » class.atkcache.inc » class.atkcache_apc.inc » class.atkcache_eaccelerator.inc » class.atkcache_file.inc » class.atkcache_memcache.inc » class.atkcache_var.inc » class.atkcache_xcache.inc » class.atkcache_zp_disk.inc » class.atkcache_zp_output.inc » class.atkcache_zp_shm.inc » class.test_atkcache_apc.inc » class.test_atkcache_eaccelerator.inc » class.test_atkcache_file.inc » class.test_atkcache_memcache.inc » class.test_atkcache_var.inc » class.test_atkcache_xcache.inc » class.test_atkcache_zp_disk.inc » class.test_atkcache_zp_output.inc » class.test_atkcache_zp_shm.inc console » class.atkconsolecontroller.inc datagrid » class.atkdatagrid.inc » class.atkdgcomponent.inc » class.atkdgeditcontrol.inc » class.atkdgevent.inc » class.atkdgindex.inc » class.atkdglimit.inc » class.atkdglist.inc » class.atkdglistener.inc » class.atkdgnorecordsfound.inc » class.atkdgpaginator.inc » class.atkdgrenderer.inc » class.atkdgsummary.inc datatypes » class.atkarraydt.inc » class.atkdatatype.inc » class.atkstringdt.inc » class.atktimedt.inc db » class.atkclusterdb.inc » class.atkclusterddl.inc » class.atkclusterquery.inc » class.atkdb.inc » class.atkddl.inc » class.atkmockdb.inc » class.atkmockddl.inc » class.atkmockquery.inc » class.atkmssqldb.inc » class.atkmssqlddl.inc » class.atkmssqlquery.inc » class.atkmysqldb.inc » class.atkmysqlddl.inc » class.atkmysqlidb.inc » class.atkmysqliddl.inc » class.atkmysqliquery.inc » class.atkmysqlquery.inc » class.atkoci8db.inc » class.atkoci8ddl.inc » class.atkoci8query.inc » class.atkoci9db.inc » class.atkoci9ddl.inc » class.atkoci9query.inc » class.atkoci805db.inc » class.atkoci805query.inc » class.atkpgsqldb.inc » class.atkpgsqlddl.inc » class.atkpgsqlquery.inc » class.atkquery.inc » class.test_atkdb.inc document » class.atkdocumentwriter.inc » class.atkdocxwriter.inc » class.atkopendocumentwriter.inc filters » class.atkdistinctfilter.inc » class.atkfilter.inc » class.atkgroupbyfilter.inc fixture » class.atkabstractfixtureloader.inc » class.atkfixturemanager.inc » class.atkphpfixtureloader.inc » class.atkyamlfixtureloader.inc front » class.atkfrontcontroller.inc » class.atkfrontcontrollerbridge.inc handlers » class.atkactionhandler.inc » class.atkaddhandler.inc » class.atkaddorcopyhandler.inc » class.atkadminhandler.inc » class.atkattributeedithandler.inc » class.atkcopyhandler.inc » class.atkdeletehandler.inc » class.atkdocumenthandler.inc » class.atkeditcopyhandler.inc » class.atkedithandler.inc » class.atkexporthandler.inc » class.atkfeedbackhandler.inc » class.atkfileexport.inc » class.atkimporthandler.inc » class.atkmultiselecthandler.inc » class.atkmultiupdatehandler.inc » class.atksavehandler.inc » class.atksearchhandler.inc » class.atkselecthandler.inc » class.atksmartsearchhandler.inc » class.atkupdatehandler.inc » class.atkvieweditbase.inc » class.atkviewhandler.inc » class.atkxmlhandler.inc » class.test_atkimporthandler.inc include » autoload.inc » basics.inc » compatibility.inc » configs.inc » debugging.inc » errorhandler.inc » globals.inc » initial.inc » security.inc interface » class.atkserver.inc » class.atksoapserver.inc » interface.atkserverinterface.inc javascript » class.atkmultilanguage.js.php » class.atkprofileattribute.js.php » dhtml_tabs.js.php keyboard » class.atkkeyboard.inc lock » class.atkdblock.inc » class.atklock.inc » lock.php lock-- » lock.js.php menu » atkmenutools.inc » class.atkcookmenu.inc » class.atkdhtmlmenu.inc » class.atkdropdownmenu.inc » class.atkframesmenu.inc » class.atkmenu.inc » class.atkmenuinterface.inc » class.atkmodernmenu.inc » class.atkoutlookmenu.inc » class.atkplainmenu.inc meta » class.atkdutchmetagrammar.inc » class.atkmetaattributemodifier.inc » class.atkmetacompiler.inc » class.atkmetagrammar.inc » class.atkmetapolicy.inc » module.inc meta-relations » class.atkmetaextendableshuttlerelation.inc » class.atkmetamanyboolrelation.inc » class.atkmetamanytomanylistrelation.inc » class.atkmetamanytomanyselectrelation.inc » class.atkmetamanytoonerelation.inc » class.atkmetaonetomanyrelation.inc » class.atkmetaonetoonerelation.inc » class.atkmetashuttlerelation.inc modules » class.atkmodule.inc modules-- » atkmoduletools.inc popups » colorpicker.inc recordlist » class.atkcolumnconfig.inc » class.atkcsvrecordlist.inc » class.atkcustomrecordlist.inc » class.atkexcelcsvrecordlist.inc » class.atkhtmlrecordlist.inc » class.atkprintablerecordlist.inc » class.atkrecordlist.inc » class.atkrecordlistcache.inc » class.atktotalizer.inc relations » class.atkextendableshuttlerelation.inc » class.atkmanyboolrelation.inc » class.atkmanytomanylistrelation.inc » class.atkmanytomanyrelation.inc » class.atkmanytomanyselectrelation.inc » class.atkmanytoonerelation.inc » class.atkmanytoonetreerelation.inc » class.atkmatrixrelation.inc » class.atkonetomanyrelation.inc » class.atkonetoonerelation.inc » class.atkrelation.inc » class.atksecurerelation.inc » class.atkshuttlecontrol.inc » class.atkshuttlefilter.inc » class.atkshuttlerelation.inc security » class.atkbajusencryption.inc » class.atkbase64encryption.inc » class.atkencryption.inc » class.atkmocksecuritymanager.inc » class.atkopensslencryption.inc » class.atksecuritylistener.inc » class.atksecuritymanager.inc » class.atkurlvault.inc » class.auth_config.inc » class.auth_db.inc » class.auth_imap.inc » class.auth_interface.inc » class.auth_ldap.inc » class.auth_none.inc » class.auth_pop3.inc » class.auth_server.inc » class.auth_sspi.inc » class.test_atkmocksecuritymanager.inc » class.test_atkurlvault.inc session » class.atksessionmanager.inc » class.atkstate.inc skel » app.php » atk.inc » config.inc.php » debugger.php » dispatch.php » include.php » index.php » menu.php » test.php » top.php » welcome.php skel- » atkappsuite.php subpackage » class.atkattributetestcase.inc test » class.atkcachetestcase.inc » class.atkphpunittestcasecollector.inc » class.atkplugintestcase.inc » class.atksimpletesttestcasecollector.inc » class.atktestcase.inc » class.atktestcasecollector.inc » class.atktestreporter.inc » class.atktestsuite.inc » class.atktesttraverser.inc » class.test_atkmocknode.inc » class.test_atktestcase.inc » class.test_atktools.inc » class.test_dbconfigs.inc » class.test_tabsecurity.inc testcases » class.atkabstractsearchhandler.inc » class.stub_atknew.inc » class.test_atkattributeedithandler.inc » class.test_atkboolattribute.inc » class.test_atkcalculatorattribute.inc » class.test_atkcolorpickerattribute.inc » class.test_atkdatagrid.inc » class.test_atkdatanode.inc » class.test_atkdateattribute.inc » class.test_atkfileattribute.inc » class.test_atkfrontcontroller.inc » class.test_atkiputils.inc » class.test_atkmanytoonerelation.inc » class.test_atknode.inc » class.test_atkrelation.inc » class.test_atktagattribute.inc » class.test_atkwizard.inc » class.test_tabs.inc themes » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc ui » block.atknavigator.php » block.atknavigatorinfo.php » class.atkactionboxbuilder.inc » class.atkdialog.inc » class.atkindexpage.inc » class.atkoutput.inc » class.atkpage.inc » class.atkpagebuilder.inc » class.atktheme.inc » class.atkthemecompiler.inc » class.atkui.inc » function.atkconfig.php » function.atkdatefield.php » function.atkdispatchfile.php » function.atkfrontcontroller.php » function.atkloadscript.php » function.atkmessages.php » function.atkmoduledir.php » function.atkscript.php » function.atkstyle.php » function.atktext.php » function.atkthemeicon.php » function.atkthemeimg.php » function.stacktrace.php » modifier.atkjson.php » modifier.atkvardump.php » resource.string.php » resource.theme.php » resource.ui.php utils » atkbrowsertools.inc » class.atkactionlistener.inc » class.atkclassloader.inc » class.atkdataholder.inc » class.atkdebugger.inc » class.atkdirectorytraverser.inc » class.atkeventlog.inc » class.atkfileutils.inc » class.atkframeset.inc » class.atkiputils.inc » class.atkjson.inc » class.atkmail.inc » class.atkmailer.inc » class.atkmessagequeue.inc » class.atkmlsplitter.inc » class.atknavigator.inc » class.atkselector.inc » class.atkstring.inc » class.atkstringparser.inc » class.atktablerenderer.inc » class.atktablerenderergrouped.inc » class.atktextmarker.inc » class.atktmpfile.inc » class.atktriggerlistener.inc » class.atkyaml.inc » class.atkzip.inc » class.test_atkactionlistener.inc » class.test_atkclassloader.inc » class.test_atkcolumnconfig.inc » class.test_atkdirectorytraverser.inc » class.test_atklistattribute.inc » class.test_atkstringparser.inc » class.test_atktextmarker.inc » help.inc wizard » class.atkwizard.inc » class.atkwizardactionloader.inc » class.atkwizardpanel.inc
Home  ->  Documentation home  ->  Atk index  ->  Docs For Class atkPage [ package: atk ]

Class: atkPage

Source Location: /ui/class.atkpage.inc

Class atkPage

Class Overview

Page renderer.

This class is used to render output as an html page. It takes care of creating a header, loading javascripts and loading stylesheets. Since any script will output exactly one page to the browser, this is a singleton. Use getInstance() to retrieve the one-and-only instance.

Located in /ui/class.atkpage.inc [line 46]

Wiki documentation



		
				Author(s):
		
		
		
Information Tags:
Todo:  This should actually not be a singleton. HTML file generation scripts may need an instance per page generated.

Properties

Methods

[ Top ]

Property Summary

String   $m_content   The content to put on the page.
Array   $m_hiddenvars   The hidden variables for the page
array   $m_loadscripts   List of javascript code statements to execute when the page is loaded.
array   $m_scriptcode   List of javascript code statements to include in the header.
array   $m_scriptfiles   The list of javascript files to load.
array   $m_stylecode   List of style statements to include in the header.
array   $m_stylesheets   List of stylesheet files to load.
array   $m_submitscripts   List of javascript code statements to execute when a form on the page is submitted.
string   $m_title   Page title.

[ Top ]

Method Summary

atkPage   __construct()   Constructor.
void   addContent()   Add content to the page.
void   addScripts()   Adds javascripts from the member variables to HTML output
void   addStyles()   Add stylesheets and stylecodes to the HMTL output
String   body()   Generate the HTML body (<body></body>) statement for the page.
string   getContent()   Returns the current page content.
atkPage   &getInstance()   Retrieve the one-and-only atkPage instance.
array   getScriptCodes()   Return all javascript codes in an array
array   getScripts()   Return all javascript files
array   getStyleCodes()   Return all style codes
array   getStyles()   Return all stylesheet files
String   head()   Generate the HTML header (<head></head>) statement for the page, including all scripts and styles.
boolean   isEmpty()   Check if the page is empty (no content).
void   register_hiddenvars()   Register hidden variables. These will be accessible to javascript and DHTML functions/scripts
void   register_loadscript()   Register a javascript code statement that is executed on pageload.
void   register_script()   Register a javascript file to be included.
void   register_scriptcode()   Register a javascript code statement which will be rendered in the header.
void   register_style()   Register a Cascading Style Sheet.
void   register_stylecode()   Register Cascading Style Sheet fragment that will be included in the page header.
void   register_submitscript()   Register a javascript code statement that is executed when a form on the page is submitted.
String   render()   Render the complete page, including head and body.
string   renderHiddenVars()   Here we render a hidden div in the page with hidden variables
void   renderPartial()   Render partial.
string   renderScriptCode()   Renders the registered javascripts, if $position is set to "before" the scripts will be placed before the scripts that are already present. Otherwise they will be appended at the end.
void   setContent()   Sets the page content (overwriting current content).
void   setTitle()   Sets the page title.
void   unregister_all_scripts()   Unregister all registered javascripts
void   unregister_style()   Unregister a Cascading Style Sheet.
String   _getGlobalLoadScriptCode()   Get the globalLoad javascript code
String   _getGlobalSubmitScriptCode()   Get the globalSubmit javascript code

[ Top ]

Properties

String   $m_content = "" [line 97]

The content to put on the page.

API Tags:
Access:  private


[ Top ]
Array   $m_hiddenvars = array() [line 104]

The hidden variables for the page

API Tags:
Access:  private


[ Top ]
array   $m_loadscripts = array() [line 76]

List of javascript code statements to execute when the page is loaded.

API Tags:
Access:  private


[ Top ]
array   $m_scriptcode = array("before"=>array(),"after"=>array()) [line 60]

List of javascript code statements to include in the header.

API Tags:
Access:  private


[ Top ]
array   $m_scriptfiles = array() [line 53]

The list of javascript files to load.

API Tags:
Access:  private


[ Top ]
array   $m_stylecode = array() [line 90]

List of style statements to include in the header.

API Tags:
Access:  private


[ Top ]
array   $m_stylesheets = array() [line 83]

List of stylesheet files to load.

API Tags:
Access:  private


[ Top ]
array   $m_submitscripts = array() [line 68]

List of javascript code statements to execute when a form on the page is submitted.

API Tags:
Access:  private


[ Top ]
string   $m_title = '' [line 111]

Page title.

API Tags:
Access:  protected


[ Top ]

Methods

Constructor __construct  [line 131]

  atkPage __construct( )

Constructor.


API Tags:
Access:  public


[ Top ]
addContent  [line 525]

  void addContent( String $content  )

Add content to the page.

Parameters:
String   $content:  The content to add to the page.


[ Top ]
addScripts  [line 369]

  void addScripts( &$res, [Bool $partial = false], String $res  )

Adds javascripts from the member variables to HTML output

Parameters:
String   $res:  Reference to the HTML output
Bool   $partial:  Is this a partial request or a complete request
   &$res: 


[ Top ]
addStyles  [line 493]

  void addStyles( &$res, [Bool $partial = false], String $res  )

Add stylesheets and stylecodes to the HMTL output

Parameters:
String   $res:  Reference to the HTML output
Bool   $partial:  Is this a partial request or a complete request
   &$res: 


[ Top ]
body  [line 555]

  String body( [String $extraprops = ""]  )

Generate the HTML body (<body></body>) statement for the page.

Parameters:
String   $extraprops:  Extra attributes to add to the <body> tag.

API Tags:
Return:  The HTML body, including <body> and </body> tags.


[ Top ]
getContent  [line 535]

  string getContent( )

Returns the current page content.


API Tags:
Return:  current page content


[ Top ]
getInstance  [line 117]

  atkPage &getInstance( )

Retrieve the one-and-only atkPage instance.



[ Top ]
getScriptCodes  [line 244]

  array getScriptCodes( )

Return all javascript codes in an array



[ Top ]
getScripts  [line 198]

  array getScripts( )

Return all javascript files


API Tags:
Return:  contain file paths


[ Top ]
getStyleCodes  [line 314]

  array getStyleCodes( )

Return all style codes



[ Top ]
getStyles  [line 293]

  array getStyles( )

Return all stylesheet files


API Tags:
Return:  contain file paths


[ Top ]
head  [line 340]

  String head( String $title, [String $extra_header = ""]  )

Generate the HTML header (<head></head>) statement for the page, including all scripts and styles.

Parameters:
String   $title:  Title of the html page.
String   $extra_header:  HTML code of extra headers to add to the head section

API Tags:
Return:  The HTML pageheader, including <head> and </head> tags.


[ Top ]
isEmpty  [line 666]

  boolean isEmpty( )

Check if the page is empty (no content).

This is useful to check at the rendering stage of scripts whether there is something to render.


API Tags:
Return:  true if there is no content in the page, false if there is


[ Top ]
register_hiddenvars  [line 325]

  void register_hiddenvars( array $hiddenvars  )

Register hidden variables. These will be accessible to javascript and DHTML functions/scripts

but will not be shown to the user unless he/she has a very, very old browser that is not capable of rendering CSS

Parameters:
array   $hiddenvars:  the hiddenvariables we want to register


[ Top ]
register_loadscript  [line 234]

  void register_loadscript( String $code  )

Register a javascript code statement that is executed on pageload.

Parameters:
String   $code:  The javascript code fragment to execute on load.


[ Top ]
register_script  [line 154]

  void register_script( String $file, [String $before = ""]  )

Register a javascript file to be included.

If called twice for the same filename, the file is loaded only once.

Parameters:
String   $file:  The (relative path and) filename of the javascript file.
String   $before:  The (partial) name of a script that this script should be loaded in front of. This can be used to inject a script before another script, or to avoid conflicts. Usually, this parameter is not needed.


[ Top ]
register_scriptcode  [line 212]

  void register_scriptcode( String $code, [Boolean $before = false]  )

Register a javascript code statement which will be rendered in the header.

The method has a duplicate check. Registering the exact same statement twice, will result in the statement only being rendered and executed once.

Parameters:
String   $code:  The javascript code to place in the header.
Boolean   $before:  Include the script before the javascript files


[ Top ]
register_style  [line 262]

  void register_style( String $file, [String $media = 'all']  )

Register a Cascading Style Sheet.

This method has a duplicate check. Calling it with the same stylesheet more than once, will still result in only one single include of the stylesheet.

Parameters:
String   $file:  The (relative path and) filename of the stylesheet.
String   $media:  The stylesheet media (defaults to 'all').


[ Top ]
register_stylecode  [line 304]

  void register_stylecode( String $code  )

Register Cascading Style Sheet fragment that will be included in the page header.

Parameters:
String   $code:  The Cascading Style Sheet code fragment to place in the header.


[ Top ]
register_submitscript  [line 225]

  void register_submitscript( String $code  )

Register a javascript code statement that is executed when a form on the page is submitted.

Parameters:
String   $code:  The javascript code fragment to execute on submit.

Information Tags:
Todo:  This is inconsequent, if multiple forms are present, each should have its own submitscripts. Should be moved to an atkForm class.

[ Top ]
render  [line 587]

  String render( [String $title = null], [bool|int $flags = HTML_STRICT], [string $extrabodyprops = ""], [string $extra_header = ""]  )

Render the complete page, including head and body.

Parameters:
String   $title:  Title of the HTML page.
bool|int   $flags:  (bool) Set to true to generate <body> tags. It is useful to set this to false only when rendering content that either already had its own <body></body> statement, or content that needs no body statements, like a frameset. (DEPRICATED !!) (int) Flags for the render function
string   $extrabodyprops:  Extra attributes to add to the <body> tag.
string   $extra_header:  HTML code of extra headers to add to the head section

API Tags:
Return:  The HTML page, including <html> and </html> tags.


[ Top ]
renderHiddenVars  [line 643]

  string renderHiddenVars( )

Here we render a hidden div in the page with hidden variables

that we want to make accessible to client side scripts


API Tags:
Return:  a hidden div with the selected ATK variabels


[ Top ]
renderPartial  [line 630]

  void renderPartial( )

Render partial.



[ Top ]
renderScriptCode  [line 416]

  string renderScriptCode( string $position  )

Renders the registered javascripts, if $position is set to "before" the scripts will be placed before the scripts that are already present. Otherwise they will be appended at the end.

Parameters:
string   $position:  ("before" or "after")


[ Top ]
setContent  [line 545]

  void setContent( string $content  )

Sets the page content (overwriting current content).

Parameters:
string   $content:  new page content


[ Top ]
setTitle  [line 569]

  void setTitle( string $title  )

Sets the page title.

Parameters:
string   $title:  page title

API Tags:
Access:  public


[ Top ]
unregister_all_scripts  [line 187]

  void unregister_all_scripts( )

Unregister all registered javascripts



[ Top ]
unregister_style  [line 280]

  void unregister_style( String $file  )

Unregister a Cascading Style Sheet.

Parameters:
String   $file:  The (relative path and) filename of the stylesheet.


[ Top ]
_getGlobalLoadScriptCode  [line 461]

  String _getGlobalLoadScriptCode( [bool $partial = false]  )

Get the globalLoad javascript code

Parameters:
bool   $partial:  Is this a partial request or a complete request

API Tags:
Return:  with javascript code


[ Top ]
_getGlobalSubmitScriptCode  [line 432]

  String _getGlobalSubmitScriptCode( [bool $partial = false]  )

Get the globalSubmit javascript code

Parameters:
bool   $partial:  Is this a partial request or a complete request

API Tags:
Return:  with javascript code


[ Top ]
Home | About | Contact