Contentserv PHP API

CSNoteIcon
in package

This class represents a icon note in the {@link CSNoteIconsPlugin}.

Tags
since

CS12.1

Table of Contents

__construct()  : mixed
Creates a new Note Icon.
addToGuiComponent()  : void
Adds this icon to a CSGuiComponent
addToToolbar()  : void
Adds this icon to a CSGuiToolbar
getDefaultText()  : string
Gets the default text which will be added to the note, if it is created
getDisplayStatus()  : bool
getHeight()  : the
getIcon()  : the
getLeft()  : the
getName()  : the
getSrc()  : the
getTop()  : the
getWidth()  : the
setDefaultText()  : mixed
Sets the default text which will be added to the note, if it is created
setDisplayStatus()  : mixed
setHeight()  : mixed
setIcon()  : mixed
setLeft()  : mixed
setName()  : mixed
setSrc()  : mixed
setTop()  : the
setWidth()  : mixed

Methods

__construct()

Creates a new Note Icon.

public __construct(string $src, string $icon, string $name[, int $width = 16 ][, int $height = 16 ], int $left, int $top[, bool $displayStatus = true ][, string $defaultText = '' ]) : mixed
Parameters
$src : string

the source of the icon relative to the admin directory. If {STATENAME} is used, this will be replaced by the color name of the state.

$icon : string

the icon which should be used as button relative to the admin directory in 19x16 pixel

$name : string

the internal name and tooltip of the Note (if not defined the basename is used)

$width : int = 16

the width of the $src image

$height : int = 16

the height of the $src image

$left : int

the left distance of the icon fix point (e.g. the end of an arrow) to the top left border of the icon

$top : int

the top distance of the icon fix point (e.g. the end of an arrow) to the top left border of the icon

$displayStatus : bool = true

whether the Workflow State should be visible as icons border

$defaultText : string = ''

the standard text, if the note is created

Tags
Return values
mixed —

addToGuiComponent()

Adds this icon to a CSGuiComponent

public addToGuiComponent(CSGuiComponent $csGuiComponent) : void
Parameters
$csGuiComponent : CSGuiComponent

the component to add the icon to (either an editor, a window, or a toolbar)

Tags
Return values
void —

addToToolbar()

Adds this icon to a CSGuiToolbar

public addToToolbar(CSGuiToolbar $toolbar) : void
Parameters
$toolbar : CSGuiToolbar

the component to add the icon to

Tags
Return values
void —

getDefaultText()

Gets the default text which will be added to the note, if it is created

public getDefaultText() : string
Tags
Return values
string —

the text, if the note is created

getDisplayStatus()

public getDisplayStatus() : bool
Tags
Return values
bool —

whether the Workflow State should be visible as icons border

getHeight()

public getHeight() : the
Tags
Return values
the —

height of the source image

getIcon()

public getIcon() : the
Tags
Return values
the —

icon which should be used as button

getLeft()

public getLeft() : the
Tags
Return values
the —

left distance of the icon fix point (e.g. the end of an arrow) to the top left border of the icon

getName()

public getName() : the
Tags
Return values
the —

internal name of the Note

getSrc()

public getSrc() : the
Tags
Return values
the —

source of the icon relative to the admin directory. If {STATENAME} is used, this will be replaced by the color name of the state.

getTop()

public getTop() : the
Tags
Return values
the —

top distance of the icon fix point (e.g. the end of an arrow) to the top left border of the icon

getWidth()

public getWidth() : the
Tags
Return values
the —

width of the source image

setDefaultText()

Sets the default text which will be added to the note, if it is created

public setDefaultText(string $defaultText) : mixed
Parameters
$defaultText : string

the standardtext, if the note is created

Tags
Return values
mixed —

setDisplayStatus()

public setDisplayStatus([bool $displayStatus = true ]) : mixed
Parameters
$displayStatus : bool = true

whether the Workflow State should be visible as icons border

Tags
Return values
mixed —

setHeight()

public setHeight(int $height) : mixed
Parameters
$height : int

height of the source image

Tags
Return values
mixed —

setIcon()

public setIcon(string $icon) : mixed
Parameters
$icon : string

the icon which should be used as button

Tags
Return values
mixed —

setLeft()

public setLeft(int $left) : mixed
Parameters
$left : int

the left distance of the icon fix point (e.g. the end of an arrow) to the top left border of the icon

Tags
Return values
mixed —

setName()

public setName(string $name) : mixed
Parameters
$name : string

the internal name of the Note

Tags
Return values
mixed —

setSrc()

public setSrc(string $src) : mixed
Parameters
$src : string

the source of the icon relative to the admin directory. If {STATENAME} is used, this will be replaced by the color name of the state.

Tags
Return values
mixed —

setTop()

public setTop(mixed $top) : the
Parameters
$top : mixed
Tags
Return values
the —

top distance of the icon fix point (e.g. the end of an arrow) to the top left border of the icon

setWidth()

public setWidth(int $width) : mixed
Parameters
$width : int

width of the source image

Tags
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results