ColorPalette (ATG Java API)

```
public interface ColorPalette
```
An interface used to describe a color set. The properties of this interface return color tokens(ie RGB Strings) for various components of a portal page. The set of colors for these components make up a color palette.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAuthor()` Access the author of the color palette
`java.lang.String`	`getBodyTagData()` Access a String containing the attributes used in the html body tag for this color palette.
`java.lang.String`	`getColor(java.lang.String pProperty)` Access a color property
`java.util.Date`	`getCreationDate()` Access the creation date of the color palette
`java.lang.String`	`getDescription()` Deprecated.
`java.lang.String`	`getDescription(java.util.Locale locale)` Returns the description of the palette in the language of the given locale
`java.lang.String`	`getGearBackgroundColor()` Access the gear background color
`java.lang.String`	`getGearTextColor()` Access the gear text color
`java.lang.String`	`getGearTitleBackgroundColor()` Acess the gear title background color
`java.lang.String`	`getGearTitleTextColor()` Access the gear title text color
`java.lang.String`	`getHighlightBackgroundColor()` Access the highlight background color
`java.lang.String`	`getHighlightTextColor()` Access the highlight text color
`java.lang.String`	`getId()` Access the id of the color palette
`java.lang.String`	`getImage(java.lang.String pProperty)` Access an image property
`java.util.Date`	`getLastModified()` Access the last modified date of the color palette
`java.lang.String`	`getName()` Deprecated.
`java.lang.String`	`getName(java.util.Locale locale)` Gets the name of the palette in the language of the given locale
`java.lang.String`	`getPageActionLinkColor()` Access the page action link color
`java.lang.String`	`getPageBackgroundColor()` Access the page background color
`java.lang.String`	`getPageBackgroundImageURL()` Returns the URL to the page background image
`java.lang.String`	`getPageLinkColor()` Access the page link color
`java.lang.String`	`getPageTextColor()` Access the page text color
`java.lang.String`	`getPageVisitedLinkColor()` Access thepage visited link color
`java.lang.String`	`getServletContext()` Access the servletContext of the color palette
`java.lang.String`	`getSmallImageURL()` Return the URL to a small image of the color palette
`java.lang.String`	`getVersion()` Access the version of the color palette
`void`	`setAuthor(java.lang.String pAuthor)` Set the author of the color palette
`void`	`setColor(java.lang.String pProperty, java.lang.String pValue)` Set a color property
`void`	`setDescription(java.lang.String pDescription)` Set the description of the color
`void`	`setDescription(java.lang.String description, java.util.Locale locale)` Sets the description for the given locale
`void`	`setImage(java.lang.String pProperty, java.lang.String pValue)` Set a color image
`void`	`setName(java.lang.String pName)` Deprecated.
`void`	`setName(java.lang.String name, java.util.Locale locale)` Sets the name of the palette for the given locale
`void`	`setServletContext(java.lang.String pServletContext)` Set the servletContext of the color palette
`void`	`setVersion(java.lang.String pVersion)` Set the version of the color palette

- Field Detail
  - CLASS_VERSION
```
static final java.lang.String CLASS_VERSION
```
    Class version string
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
java.lang.String getId()
```
    Access the id of the color palette
    
    Returns:
    
    an id
  - getName
```
java.lang.String getName()
```
    Deprecated.
    
    Access the name of the color palette
    
    Returns:
    
    a name
  - getName
```
java.lang.String getName(java.util.Locale locale)
```
    Gets the name of the palette in the language of the given locale
  - setName
```
void setName(java.lang.String pName)
```
    Deprecated.
    
    Set the name of the color palette
    
    Parameters:
    
    a - url
  - setName
```
void setName(java.lang.String name,
             java.util.Locale locale)
```
    Sets the name of the palette for the given locale
  - getServletContext
```
java.lang.String getServletContext()
```
    Access the servletContext of the color palette
    
    Returns:
    
    a servletContext
  - setServletContext
```
void setServletContext(java.lang.String pServletContext)
```
    Set the servletContext of the color palette
    
    Parameters:
    
    a - servletContext
  - getDescription
```
java.lang.String getDescription()
```
    Deprecated.
    
    Access the description of the color palette
    
    Returns:
    
    a description
  - getDescription
```
java.lang.String getDescription(java.util.Locale locale)
```
    Returns the description of the palette in the language of the given locale
  - setDescription
```
void setDescription(java.lang.String pDescription)
```
    Set the description of the color
    
    Parameters:
    
    a - description
  - setDescription
```
void setDescription(java.lang.String description,
                    java.util.Locale locale)
```
    Sets the description for the given locale
  - getCreationDate
```
java.util.Date getCreationDate()
```
    Access the creation date of the color palette
    
    Returns:
    
    a date
  - getLastModified
```
java.util.Date getLastModified()
```
    Access the last modified date of the color palette
    
    Returns:
    
    a date
  - getAuthor
```
java.lang.String getAuthor()
```
    Access the author of the color palette
    
    Returns:
    
    an author name
  - setAuthor
```
void setAuthor(java.lang.String pAuthor)
```
    Set the author of the color palette
    
    Parameters:
    
    a - author
  - getVersion
```
java.lang.String getVersion()
```
    Access the version of the color palette
    
    Returns:
    
    a version
  - setVersion
```
void setVersion(java.lang.String pVersion)
```
    Set the version of the color palette
    
    Parameters:
    
    a - version
  - getPageBackgroundColor
```
java.lang.String getPageBackgroundColor()
```
    Access the page background color
    
    Returns:
    
    a color token
  - getPageBackgroundImageURL
```
java.lang.String getPageBackgroundImageURL()
```
    Returns the URL to the page background image
    
    Returns:
    
    a url
  - getSmallImageURL
```
java.lang.String getSmallImageURL()
```
    Return the URL to a small image of the color palette
    
    Returns:
    
    a url
  - getPageTextColor
```
java.lang.String getPageTextColor()
```
    Access the page text color
    
    Returns:
    
    a color token
  - getPageLinkColor
```
java.lang.String getPageLinkColor()
```
    Access the page link color
    
    Returns:
    
    a color token
  - getPageActionLinkColor
```
java.lang.String getPageActionLinkColor()
```
    Access the page action link color
    
    Returns:
    
    a color token
  - getPageVisitedLinkColor
```
java.lang.String getPageVisitedLinkColor()
```
    Access thepage visited link color
    
    Returns:
    
    a color token
  - getGearTitleBackgroundColor
```
java.lang.String getGearTitleBackgroundColor()
```
    Acess the gear title background color
    
    Returns:
    
    a color token
  - getGearTitleTextColor
```
java.lang.String getGearTitleTextColor()
```
    Access the gear title text color
    
    Returns:
    
    a color token
  - getGearBackgroundColor
```
java.lang.String getGearBackgroundColor()
```
    Access the gear background color
    
    Returns:
    
    a color token
  - getGearTextColor
```
java.lang.String getGearTextColor()
```
    Access the gear text color
    
    Returns:
    
    a color token
  - getHighlightTextColor
```
java.lang.String getHighlightTextColor()
```
    Access the highlight text color
    
    Returns:
    
    a color token
  - getHighlightBackgroundColor
```
java.lang.String getHighlightBackgroundColor()
```
    Access the highlight background color
    
    Returns:
    
    a color token
  - getColor
```
java.lang.String getColor(java.lang.String pProperty)
```
    Access a color property
    
    Returns:
    
    a color token
  - setColor
```
void setColor(java.lang.String pProperty,
              java.lang.String pValue)
```
    Set a color property
    
    Parameters:
    
    color - property
    
    color - value
  - getImage
```
java.lang.String getImage(java.lang.String pProperty)
```
    Access an image property
    
    Returns:
    
    an image token
  - setImage
```
void setImage(java.lang.String pProperty,
              java.lang.String pValue)
```
    Set a color image
    
    Parameters:
    
    image - property
    
    image - url
  - getBodyTagData
```
java.lang.String getBodyTagData()
```
    Access a String containing the attributes used in the html body tag for this color palette. This String contains values for bgcolor, background, text, link, vlink and alink. This String can be used to correctly set up an html page with the correct body attributes for this color palette.
    
    Returns:
    
    a html body tag string

Interface ColorPalette

Field Summary

Method Summary

Field Detail

CLASS_VERSION

Method Detail

getId

getName

getName

setName

setName

getServletContext

setServletContext

getDescription

getDescription

setDescription

setDescription

getCreationDate

getLastModified

getAuthor

setAuthor

getVersion

setVersion

getPageBackgroundColor

getPageBackgroundImageURL

getSmallImageURL

getPageTextColor

getPageLinkColor

getPageActionLinkColor

getPageVisitedLinkColor

getGearTitleBackgroundColor

getGearTitleTextColor

getGearBackgroundColor

getGearTextColor

getHighlightTextColor

getHighlightBackgroundColor

getColor

setColor

getImage

setImage

getBodyTagData