atg.portal.framework
Interface GearTitleBarDefinition

public interface GearTitleBarDefinition

Represents a Gears Titlebar Definition

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

java.lang.String	getAuthor() Access the author
java.util.Date	getCreationDate() Access the creation date of the titlebar
java.lang.String	getDescription() Access the description of the titlebar
GearTitleBarMode	getGearTitleBarMode(java.lang.String pTitleBarMode) Access a named titlebar mode from the titlebar
GearTitleBarMode[]	getGearTitleBarModes() Access all titlebar modes
java.lang.String	getId() Access the id of the titlebar
java.lang.String	getLargeImageURL() Access the large image URL
java.util.Date	getLastModified() Access the last modified date of the titlebar
java.lang.String	getName() Access the name of the titlebar
java.lang.String	getServletContext() Access the servlet context
java.lang.String	getSmallImageURL() Access the small image URL
java.lang.String	getVersion() Access the version
boolean	hasGearTitleBarMode(java.lang.String pTitleBarMode) Returns true is this titlebar has a particuar titlebar mode

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 titlebar

Returns:

an id

getName

java.lang.String getName()

Access the name of the titlebar

Returns:

a name

getDescription

java.lang.String getDescription()

Access the description of the titlebar

Returns:

an id

getCreationDate

java.util.Date getCreationDate()

Access the creation date of the titlebar

Returns:

a date

getLastModified

java.util.Date getLastModified()

Access the last modified date of the titlebar

Returns:

a date

getAuthor

java.lang.String getAuthor()

Access the author

Returns:

the author

getVersion

java.lang.String getVersion()

Access the version

Returns:

the version

getSmallImageURL

java.lang.String getSmallImageURL()

Access the small image URL

Returns:

the small image url

getLargeImageURL

java.lang.String getLargeImageURL()

Access the large image URL

Returns:

the large image url

getServletContext

java.lang.String getServletContext()

Access the servlet context

Returns:

the servlet context

hasGearTitleBarMode

boolean hasGearTitleBarMode(java.lang.String pTitleBarMode)

Returns true is this titlebar has a particuar titlebar mode

Parameters:

pTitleBarMode - the name of a titlebar mode

Returns:

true if titlebar mode exists, false otherwise

getGearTitleBarMode

GearTitleBarMode getGearTitleBarMode(java.lang.String pTitleBarMode)

Access a named titlebar mode from the titlebar

Parameters:

pTitleBarMode - the name of a titlebar mode

Returns:

a titlebar mode

getGearTitleBarModes

GearTitleBarMode[] getGearTitleBarModes()

Access all titlebar modes

Returns:

an array of titlebar modes