Manual and Documentation

NOTE: This manual describes HammerKit version 3.5. To view documentation for the current release of HammerKit Studio, please go to http://manual.hammerkit.com/
search
Index / D. Object API / Classes / HammerKit_ColorPalette

A. Introduction
B. Installation and Configuration
C. Using HammerKit tools
D. Object API
Classes
Button
FileUtils
HammerKit_BasicFile
HammerKit_Color
HammerKit_ColorPalette
HammerKit_Component
HammerKit_Converter
HammerKit_CssRule
HammerKit_Db
HammerKit_DbQueryResult
HammerKit_Document
HammerKit_Element
HammerKit_File
HammerKit_GenericObject
HammerKit_Image
HammerKit_Keyword
HammerKit_ObjectCache
HammerKit_ObjectList
HammerKit_Session
HammerKit_Shortcut
HammerKit_Site
HammerKit_System
HammerKit_User
HammerKit_UserGroup
HammerKit_VariableHandler
Style
Interfaces
Object Choosers
Global Variables
Modules
Tools
Converters
Using the API
E. HammerScript
F. Access Rights
HammerKit_ColorPalette


Implements interface: HammerKit_ObjectInterface

This class describes and contains the functionality for adding, removing and managing color palettes and their attributes. A color palette is identified by its database id, which is an integer number. Color palettes are used for grouping colors, i.e. HammerKit_Color objects.



Attributes

string description
Description: The user specified description for the object.
Settable: yes

unique integer id
Description: The database id number of the object.
Settable: no

string name
Description: The user specified name of the object.
Settable: yes



Methods

static HammerKit_ColorPalette add(array attributes)
Description: see the description of the HammerKit_ObjectInterface interface

string getAttribute(string attribute [, boolean formatted [, array format_options]])
Description: see the description of the HammerKit_ObjectInterface interface

static array getAttributeList([string property])
Description: see the description of the HammerKit_ObjectInterface interface

static HammerKit_ColorPalette getInstance(integer id)
Description: see the description of the HammerKit_ObjectInterface interface

static HammerKit_ObjectList:HammerKit_ColorPalette getList([array where])
Description: see the description of the HammerKit_ObjectInterface interface

boolean remove(void)
Description: see the description of the HammerKit_ObjectInterface interface

boolean setAttribute(string name, mixed value)
Description: see the description of the HammerKit_ObjectInterface interface

boolean setAttributes(array attributes)
Description: see the description of the HammerKit_ObjectInterface interface



� HammerKit Oy 2008 UPDATED: 26.01.2009 15:38