phpDocumentor base
[ class tree: base ] [ index: base ] [ all elements ]

Class: Css

Source Location: /myphp-1.9/myphp-1.9-base/html/page/Css.php

Class Css

Direct descendents
Child Class Description
CssBase The CSS for the Base package
CssForm Generates the Form CSS
CssLayout Generates the Layout CSS
CssMenu Generates the Menu CSS
CssTab Generates the Tab CSS
CssTable Generates the Table CSS

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Html

Html::$elements
Html::$sizeof

Inherited From Object

Object::$cachefile
Object::$html
Object::$sql

Inherited From Html

Html::Html()
Constructor
Html::add()
Add an element, the number of elements are stored internally in an array.
Html::content()
Read the content of the specified filename
Html::display()
Display the html
Html::get()
Get the complete html for a key
Html::getAttribute()
Get the complete html for an attribute, i.e. <a class="myclass" ...
Html::getElement()
Get the element at position $i in array
Html::getElements()
Get all the elements as html
Html::getHtml()
Get Html
Html::getHtmlHelp()
Get html help
Html::getSizeof()
Get the number of elements added
Html::getTag()
Get the complete html for a html tag, i.e. <p>My paragraph</p>
Html::read()
Read the content of the specified filename and language
Html::set()
Set the named attribute (key) of a class to specified value
Html::setObject()
Set the named object to the class attribute (key), with same name
Html::showsource()
Show source
Html::update()
Save the content of the specified filename and language

Inherited From Object

Object::Object()
Constructor
Object::addHtml()
Add the current html to the SourceCode object
Object::getCacheFileName()
Returns the name of the cache file name
Object::getClassName()
Returns the name of the instanciated class
Object::getHtml()
Returns the html for the element
Object::getMsg()
Get the formatted message and debug level and Log to file ?
Object::save()
Save the SQL cache file
Object::setCacheFileName()
Set the path/name of the cache file
Object::toString()
Returns the information for this class
Object::write()
Write the content to the file opened by fp

[ Top ]
Method Summary
Css   Css()   Constructor
void   display()   Display html
String   getBorder()   Returns the css class details for a Border in a component
String   getBorderLine()   Returns the css class details for a single Border side in a component
String   getBorderSingle()   Returns the css class details for a single Border line in a component
String   getButton()   Returns the css class details for a Border in a component
String   getClass()   Returns the css class details for the specified class name
String   getComponent()   Returns the css class details for a link and image in a component
String   getCss()   Returns the css for a css style
String   getCustom()   Returns the css Base components
String   getEnd()   Returns the css end
String   getExternal()   Returns the html for the external css files
String   getFieldset()   Returns the css for the fieldset tag
String   getHeader()   Returns the css header
String   getHidden()   Returns the css class details for the hidden content
String   getHr()   Returns the css class details for the hr html tag
String   getHtml()   Returns the html for the css file
String   getImage()   Returns the css class details for a background image
String   getInline()   Returns the html for the Inline css files
String   getLegend()   Returns the css for the legend tag
String   getLi()   Returns the css class details for the list <li> html tag
String   getLink()   Returns the css class details for an active, visited link
String   getLinkHover()   Returns the css class details for a hover link
String   getLinkImage()   Returns the css class details for an image inside a link
String   getLinkNormal()   Returns the css class details for an active, visited link
String   getSingle()   Returns the css class details for the single html tag
String   getStart()   Returns the css for the start of a tag
String   getTab()   Returns the css class details for a Tab in a component
String   getTabActive()   Returns the css class details for an active Tab in a component
String   getTabBody()   Returns the css class details for a Tab Body in a component
String   getTag()   Returns the css details for the specified html tag(s)
String   getWidth()   Returns the css class for the html tag

[ Top ]
Methods
Constructor Css  [line 46]

  Css Css( [String $href = '']  )

Constructor

Parameters:
String   $href:  The url to the css filename (i.e. /css/my.css)


[ Top ]
display  [line 805]

  void display( [String $href = '']  )

Display html

  1. Usage:
  2. Css::display($href);

Parameters:
String   $href:  The url to the css file (i.e. /cache/css/my.css)

API Tags:
Static:  


Redefinition of:
Html::display()
Display the html

Redefined in descendants as:

[ Top ]
getBorder  [line 279]

  String getBorder( String $name, [String $color = ''], [String $width = ''], [String $topstyle = ''], [String $leftstyle = ''], [String $rightstyle = ''], [String $bottomstyle = '']  )

Returns the css class details for a Border in a component

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $width:  The width of the class
String   $topstyle:  The top style of the class
String   $leftstyle:  The left style of the class
String   $rightstyle:  The right style of the class
String   $bottomstyle:  The bottom style of the class

API Tags:
Return:  the complete css


[ Top ]
getBorderLine  [line 243]

  String getBorderLine( [String $side = ''], [String $color = ''], [String $width = ''], [String $style = '']  )

Returns the css class details for a single Border side in a component

Parameters:
String   $side:  The Side of the border (top,left,right or bottom)
String   $color:  The Color of the border
String   $width:  The width of the border
String   $style:  The style of the border

API Tags:
Return:  the complete css


[ Top ]
getBorderSingle  [line 260]

  String getBorderSingle( [String $name = ''], [String $side = ''], [String $color = ''], [String $width = ''], [String $style = '']  )

Returns the css class details for a single Border line in a component

Parameters:
String   $name:  The Name of the border class
String   $side:  The Side of the border (top,left,right or bottom)
String   $color:  The Color of the border
String   $width:  The width of the border
String   $style:  The style of the border

API Tags:
Return:  the complete css


[ Top ]
getButton  [line 387]

  String getButton( String $name, [String $color = ''], [String $backgroundcolor = '']  )

Returns the css class details for a Border in a component

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class

API Tags:
Return:  the complete css


[ Top ]
getClass  [line 455]

  String getClass( String $name, [String $color = ''], [String $backgroundcolor = ''], [String $width = ''], [String $textalign = ''], [mixed $backgroundimage = ''], [mixed $backgroundrepeat = '']  )

Returns the css class details for the specified class name

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $width:  The width of the element
String   $textalign:  The text align of the element

API Tags:
Return:  the complete css


[ Top ]
getComponent  [line 226]

  String getComponent( String $name, [String $color = ''], [String $backgroundcolor = ''], [String $fontsize = ''], [String $fontweight = ''], [String $textdecoration = ''], [String $width = '']  )

Returns the css class details for a link and image in a component

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $fontsize:  The font size of the element
String   $fontweight:  The font weight of the element
String   $textdecoration:  The text decoration of the element
String   $width:  The width of the element

API Tags:
Return:  the complete css


[ Top ]
getCss  [line 595]

  String getCss( String $name, String $value  )

Returns the css for a css style

Parameters:
String   $name:  The Css Name of the style
String   $value:  The Css Value of the style

API Tags:
Return:  the complete css


[ Top ]
getCustom  [line 778]

  String getCustom( )

Returns the css Base components


API Tags:
Return:  the complete css
Abstract:  


Redefined in descendants as:

[ Top ]
getEnd  [line 681]

  String getEnd( )

Returns the css end


API Tags:
Return:  the complete css


[ Top ]
getExternal  [line 55]

  String getExternal( )

Returns the html for the external css files


API Tags:
Return:  the complete html


[ Top ]
getFieldset  [line 626]

  String getFieldset( String $name, [String $color = ''], [String $backgroundcolor = ''], [String $bordercolor = ''], [String $width = '']  )

Returns the css for the fieldset tag

Parameters:
String   $name:  The Name of the html tag
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $bordercolor:  The Color of the border
String   $width:  The width of the element

API Tags:
Return:  the complete css


[ Top ]
getHeader  [line 690]

  String getHeader( String $description  )

Returns the css header

Parameters:
String   $description:  The Description

API Tags:
Return:  the complete css


[ Top ]
getHidden  [line 522]

  String getHidden( String $name, [String $key = ''], [String $value = '']  )

Returns the css class details for the hidden content

Parameters:
String   $name:  The Name of the single html tag
String   $key:  The Style key to use
String   $value:  The Style value to use

API Tags:
Return:  the complete css


[ Top ]
getHr  [line 542]

  String getHr( [String $color = ''], [String $backgroundcolor = ''], [String $height = '']  )

Returns the css class details for the hr html tag

Parameters:
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $height:  The height of the class

API Tags:
Return:  the complete css


[ Top ]
getHtml  [line 786]

  String getHtml( )

Returns the html for the css file


API Tags:
Return:  the complete html


Redefinition of:
Html::getHtml()
Get Html

[ Top ]
getImage  [line 202]

  String getImage( String $name, [String $url = ''], [String $repeat = '']  )

Returns the css class details for a background image

Parameters:
String   $name:  The Name of the CSS class
String   $url:  The url for the image
String   $repeat:  The background repeat/no-repeat

API Tags:
Return:  the complete css


[ Top ]
getInline  [line 712]

  String getInline( )

Returns the html for the Inline css files


API Tags:
Return:  the complete html


[ Top ]
getLegend  [line 657]

  String getLegend( String $name, [String $color = ''], [String $backgroundcolor = ''], [String $bordercolor = '']  )

Returns the css for the legend tag

Parameters:
String   $name:  The Name of the html tag
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $bordercolor:  The Color of the border

API Tags:
Return:  the complete css


[ Top ]
getLi  [line 487]

  String getLi( String $name, String $styletype, String $styleimage  )

Returns the css class details for the list <li> html tag

Parameters:
String   $name:  The Name of the li html tag
String   $styletype:  The Style Type to use
String   $styleimage:  The Style Image to use

API Tags:
Return:  the complete css


[ Top ]
getLink  [line 100]

  String getLink( String $name, [String $color = ''], [String $backgroundcolor = ''], [String $fontsize = ''], [String $fontweight = ''], [String $textdecoration = '']  )

Returns the css class details for an active, visited link

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $fontsize:  The font size of the element
String   $fontweight:  The font weight to use
String   $textdecoration:  The text decoration to use

API Tags:
Return:  the complete css


[ Top ]
getLinkHover  [line 162]

  String getLinkHover( [String $name = ''], [String $color = ''], [String $backgroundcolor = ''], [String $fontsize = ''], [String $fontweight = ''], [String $textdecoration = '']  )

Returns the css class details for a hover link

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $fontsize:  The font size of the element
String   $fontweight:  The font weight to use
String   $textdecoration:  The text decoration to use

API Tags:
Return:  the complete css


[ Top ]
getLinkImage  [line 181]

  String getLinkImage( String $name, [String $color = ''], [String $backgroundcolor = '']  )

Returns the css class details for an image inside a link

This is a bugfix for xhtml 1.0 strict compliance border="0" in the html <img border="0" ... /> which is not validated correctly

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class

API Tags:
Return:  the complete css


[ Top ]
getLinkNormal  [line 142]

  String getLinkNormal( String $name, [String $color = ''], [String $backgroundcolor = ''], [String $fontsize = ''], [String $fontweight = ''], [String $textdecoration = '']  )

Returns the css class details for an active, visited link

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $fontsize:  The font size of the element
String   $fontweight:  The font weight to use
String   $textdecoration:  The text decoration to use

API Tags:
Return:  the complete css


[ Top ]
getSingle  [line 507]

  String getSingle( String $name, String $key, String $value  )

Returns the css class details for the single html tag

Parameters:
String   $name:  The Name of the single html tag
String   $key:  The Style key to use
String   $value:  The Style value to use

API Tags:
Return:  the complete css


[ Top ]
getStart  [line 579]

  String getStart( String $name  )

Returns the css for the start of a tag

Parameters:
String   $name:  The Name of the html tag

API Tags:
Return:  the complete css


[ Top ]
getTab  [line 305]

  String getTab( String $name, [String $color = ''], [String $backgroundcolor = ''], [String $bordercolor = '']  )

Returns the css class details for a Tab in a component

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $bordercolor:  The Color of the border

API Tags:
Return:  the complete css


[ Top ]
getTabActive  [line 333]

  String getTabActive( String $name, [String $color = ''], [String $backgroundcolor = ''], [String $bordercolor = '']  )

Returns the css class details for an active Tab in a component

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $bordercolor:  The Color of the border

API Tags:
Return:  the complete css


[ Top ]
getTabBody  [line 361]

  String getTabBody( String $name, [String $color = ''], [String $backgroundcolor = ''], [String $bordercolor = '']  )

Returns the css class details for a Tab Body in a component

Parameters:
String   $name:  The Name of the CSS class
String   $color:  The Color of the class
String   $backgroundcolor:  The Background Color of the class
String   $bordercolor:  The Color of the border

API Tags:
Return:  the complete css


[ Top ]
getTag  [line 416]

  String getTag( String $name, [String $color = ''], [String $backgroundcolor = ''], [String $fontfamily = ''], [String $fontsize = ''], [String $textalign = ''], [String $margintop = ''], [String $marginleft = ''], String $width  )

Returns the css details for the specified html tag(s)

Parameters:
String   $name:  The tag name(s) for one or more html tags
String   $color:  The Color of the tag
String   $backgroundcolor:  The Background Color of the tag
String   $width:  The width of the tag
String   $fontfamily:  The font size of the tag
String   $fontsize:  The font size of the tag
String   $textalign:  The text align of the tag
String   $margintop:  The margin top/bottom for the tag
String   $marginleft:  The margin left/right for the tag

API Tags:
Return:  the complete css


Redefinition of:
Html::getTag()
Get the complete html for a html tag, i.e. <p>My paragraph</p>

[ Top ]
getWidth  [line 565]

  String getWidth( String $name, String $width, [String $help = '']  )

Returns the css class for the html tag

Parameters:
String   $name:  The Name of the single html tag
String   $width:  The width to use
String   $help:  The help style to use

API Tags:
Return:  the complete css


[ Top ]

Documentation generated on Thu, 22 Dec 2005 17:04:17 +0100 by phpDocumentor 1.3.0RC3