Dashboard

Class DashboardCategoryAttribute

java.lang.Object

Dashboard.DashboardCategoryAttribute

public class DashboardCategoryAttribute
extends Object

Data class for attributes of a dashboard category

Field Summary

Fields

Modifier and Type	Field and Description
BBjString	AttributesStringTemplate$ DashboardCategoryAttribute string template
BBjNumber	FixedWidgetWidth FixedWidgetWidth attribute
BBjNumber	MaxWidgetWidth MaxWidgetWidth attribute
BBjNumber	MinWidgetWidth MinWidgetWidth attribute
BBjString	Name$ Name attribute
BBjNumber	WidgetSizingModel WidgetSizingModel attribute

Constructor Summary

Constructors

Constructor and Description
DashboardCategoryAttribute() Constructs a DashboardCategoryAttribute with default values.
DashboardCategoryAttribute(BBjString p_stringTemplateString!) Constructs a DashboardCategoryAttribute given a string template.
DashboardCategoryAttribute(BBjString p_name$, BBjNumber p_widgetSizingModel, BBjNumber p_minWidgetWidth, BBjNumber p_maxWidgetWidth, BBjNumber p_fixedWidgetWidth) Constructs a DashboardCategoryAttribute given all the field values
DashboardCategoryAttribute(DashboardCategory p_category!) Constructs a DashboardCategoryAttribute given an existing DashboardCategory.

Method Summary

Modifier and Type	Method and Description
BBjString	getTemplatedStringRepresentation() Gets a BBjTemplatedString representation of the DashboardCategoryAttribute

Methods inherited from class java.lang.Object

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

Field Detail

Name$

public BBjString Name$

Name attribute

WidgetSizingModel

public BBjNumber WidgetSizingModel

WidgetSizingModel attribute

MinWidgetWidth

public BBjNumber MinWidgetWidth

MinWidgetWidth attribute

MaxWidgetWidth

public BBjNumber MaxWidgetWidth

MaxWidgetWidth attribute

FixedWidgetWidth

public BBjNumber FixedWidgetWidth

FixedWidgetWidth attribute

AttributesStringTemplate$

public BBjString AttributesStringTemplate$

DashboardCategoryAttribute string template

Constructor Detail

DashboardCategoryAttribute

public DashboardCategoryAttribute(BBjString p_name$,
BBjNumber p_widgetSizingModel,
BBjNumber p_minWidgetWidth,
BBjNumber p_maxWidgetWidth,
BBjNumber p_fixedWidgetWidth)

Constructs a DashboardCategoryAttribute given all the field values

Parameters:

p_name$ - Unique name of the dashboard category

p_widgetSizingModel - The widget sizing model to use. See the DashboardCategory WIDGIT_SIZING constants. 0 = Dynamic, 1 = Fixed

p_minWidgetWidth - The minimum widget width for dynamic widget sizing

p_maxWidgetWidth - The maximum widget width for dynamic widget sizing

p_fixedWidgetWidth - The widget width for fixed widget sizing

DashboardCategoryAttribute

public DashboardCategoryAttribute(DashboardCategory p_category!)

Constructs a DashboardCategoryAttribute given an existing DashboardCategory. The DashboardCategoryAttribute's fields are populated automatically from the DashboardCategory.

Parameters:

p_category! - A DashboardCategory for which to create the attribute object

DashboardCategoryAttribute

public DashboardCategoryAttribute(BBjString p_stringTemplateString!)

Constructs a DashboardCategoryAttribute given a string template. The DashboardCategoryAttribute's fields are populated automatically from the values stored in the string template.

Parameters:

p_stringTemplateString! - A BBjString representation of a BBjTemplatedString filled out with the attributes of the DashboardCategoryAttribute

DashboardCategoryAttribute

public DashboardCategoryAttribute()

Constructs a DashboardCategoryAttribute with default values. Note that the name must be set to a unique value later for the DashboardCategoryAttribute to be valid.

Method Detail

getTemplatedStringRepresentation

public BBjString getTemplatedStringRepresentation()

Gets a BBjTemplatedString representation of the DashboardCategoryAttribute

Returns:

BBjString A BBjTemplatedString representation (BBjTemplatedString::getString()) of the DashboardCategoryAttribute