com.cc.framework.ui.model
Class FrameTitle

java.lang.Object
  com.cc.framework.ui.model.FrameTitle

All Implemented Interfaces:

java.lang.Cloneable

public class FrameTitle

extends java.lang.Object

implements java.lang.Cloneable

Version:

$Revision: 1.4 $

Author:

Harald Schulz

Field Summary

private java.util.Collection	buttons Collection of ConcreteElements for the Frames button bar
private java.lang.String	caption The localized caption Text
private java.lang.String	detail The localized detail Text
private boolean	filter Indicates if String resources should be converted to HTML
private java.lang.String	helpId The Help Id for this Frame
private ImageModel	image The optional title image
private java.lang.String	tooltip Title Tooltip

Constructor Summary

FrameTitle()
Constructor

FrameTitle(ImageModel image, java.lang.String caption, java.lang.String detail, java.lang.String helpId, java.util.Collection buttons)
Constructor

Method Summary

boolean	filter() Indicates if String resources should be converted to HTML
java.util.Iterator	getButtons()
java.lang.String	getCaption()
java.lang.String	getDetail()
java.lang.String	getHelpId()
ImageModel	getImage() Returns the image for the frames title
java.lang.String	getTooltip()
boolean	hasButtons() Checks if this Title has any Button Elements assigned
boolean	hasDetail() Checks if the title has a detail text
void	setButtons(java.util.Collection collection) Sets the ConcreteElement collection of button elements for the title
void	setCaption(java.lang.String string)
void	setDetail(java.lang.String string)
void	setFilter(boolean b)
void	setHelpId(java.lang.String string)
void	setImage(ImageModel img) Sets an image for the frames title
void	setTooltip(java.lang.String string)

Methods inherited from class java.lang.Object

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

Field Detail

tooltip

private java.lang.String tooltip

Title Tooltip

caption

private java.lang.String caption

The localized caption Text

detail

private java.lang.String detail

The localized detail Text

helpId

private java.lang.String helpId

The Help Id for this Frame

filter

private boolean filter

Indicates if String resources should be converted to HTML

buttons

private java.util.Collection buttons

Collection of ConcreteElements for the Frames button bar

image

private ImageModel image

The optional title image

Constructor Detail

FrameTitle

public FrameTitle()

Constructor

FrameTitle

public FrameTitle(ImageModel image,
                  java.lang.String caption,
                  java.lang.String detail,
                  java.lang.String helpId,
                  java.util.Collection buttons)

Constructor

Parameters:

image - The optional frame image

caption - The localized caption Text

detail - The localized detail Text

helpId - The Help Id for this Frame

buttons - Collection with button elements

Method Detail

hasButtons

public boolean hasButtons()

Checks if this Title has any Button Elements assigned

Returns:

true if button elements are assigned

getButtons

public java.util.Iterator getButtons()

Returns:

returns an iterator for the button (ConcreteElement) elements

getCaption

public java.lang.String getCaption()

Returns:

returns the caption text

getDetail

public java.lang.String getDetail()

Returns:

returns the detail text

hasDetail

public boolean hasDetail()

Checks if the title has a detail text

Returns:

returns true if the title has a detail text

filter

public boolean filter()

Indicates if String resources should be converted to HTML

Returns:

true if HTML conversion should be made

getHelpId

public java.lang.String getHelpId()

Returns:

Help Id of the Title Element

getTooltip

public java.lang.String getTooltip()

Returns:

Title Tooltip Text

getImage

public ImageModel getImage()

Returns the image for the frames title

Returns:

ImageModel

setButtons

public void setButtons(java.util.Collection collection)

Sets the ConcreteElement collection of button elements for the title

Parameters:

collection - ConcreteElement Collection

setCaption

public void setCaption(java.lang.String string)

Parameters:

string - Caption Text

setDetail

public void setDetail(java.lang.String string)

Parameters:

string - Detail Text

setFilter

public void setFilter(boolean b)

Parameters:

b - true to enable HTML Conversion. The default is true

setHelpId

public void setHelpId(java.lang.String string)

Parameters:

string - Help Id

setTooltip

public void setTooltip(java.lang.String string)

Parameters:

string - Tooltip Text

setImage

public void setImage(ImageModel img)

Sets an image for the frames title

Parameters:

img - ImageModel