org.wpi.gdc.cms.main
Class Icon

java.lang.Object
  |
  +--org.wpi.gdc.cms.main.Icon

public class Icon

extends java.lang.Object

An icon is basically just a URL to an image. It's used to flag various portions of the CMS site.

Version:

1.3

Author:

dmpotter

Constructor Summary

Icon(int id, java.lang.String name, java.lang.String alt, java.lang.String url)
Creates an Icon - usually this method is called only by the DBEngine, but it can be used to create new icons as well.

Method Summary

java.lang.String	getAlt() Retreives the Alt text for this Icon.
int	getID() Retreives the ID of this Icon.
java.lang.String	getName() Retreives the name of this Icon.
java.lang.String	getURL() Retreives the URL for this Icon.
void	setAlt(java.lang.String alt) Sets the ALT text for this Icon.
void	setName(java.lang.String name) Sets the Name of this Icon.
void	setURL(java.lang.String url) Sets the URL for this Icon.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Icon

public Icon(int id,
            java.lang.String name,
            java.lang.String alt,
            java.lang.String url)

Creates an Icon - usually this method is called only by the DBEngine, but it can be used to create new icons as well.

Parameters:

id - the ID of the icon. If this icon is not from the database, a negative value should be used for the ID, signaling the DBEngine should pick an ID for the icon when inserting it into the database.

name - a text representation of the icon

alt - the value of the ALT tag when the icon is displayed via an image.

url - the URL where the image resides (it may be relative to the server, it is inserted into the HTML IMG tag).

Method Detail

getID

public int getID()

Retreives the ID of this Icon.

Returns:

the ID of this Icon.

getName

public java.lang.String getName()

Retreives the name of this Icon.

Returns:

the name of this Icon.

getAlt

public java.lang.String getAlt()

Retreives the Alt text for this Icon.

Returns:

the Alt for this Icon.

getURL

public java.lang.String getURL()

Retreives the URL for this Icon.

Returns:

the URL for this Icon.

setName

public void setName(java.lang.String name)

Sets the Name of this Icon.

Parameters:

name - the new name for this Icon.

setAlt

public void setAlt(java.lang.String alt)

Sets the ALT text for this Icon.

Parameters:

alt - the new ALT text for this Icon.

setURL

public void setURL(java.lang.String url)

Sets the URL for this Icon.

Parameters:

name - the new URL for this Icon.