Packagecom.flexicious.components.valueobjects
Classpublic class DashletInfo
InheritanceDashletInfo Inheritance Object

A class that holds information about the location, parent zone, dimensions of a dashlet. Can contain only serilizable information (so we can persist preferences)



Public Properties
 PropertyDefined By
  dashletIdentifier : String
The uniqueIdentifier for the dashlet
DashletInfo
  hasTitleBar : Boolean
Whether the dashet is showing the title bar
DashletInfo
  height : Number
The height from the dimensions array
DashletInfo
  isCollapsed : Boolean
Whether the dashet is collapsed
DashletInfo
  isHeightPercent : Boolean
Whether the height is in percentage
DashletInfo
  isMinimized : Boolean
Whether the dashet is minimized to the the task bar
DashletInfo
  isOpen : Boolean
Whether the dashet is open
DashletInfo
  isWidthPercent : Boolean
Whether the width is in percentage
DashletInfo
  width : Number
The width from the dimensions array
DashletInfo
  x : Number
The x from the dimensions array
DashletInfo
  y : Number
The y from the dimensions array
DashletInfo
  zoneElementIndex : int
The element index of this dashlet within the zone
DashletInfo
  zoneIdentifier : String
The uniqueIdentifier for the zone
DashletInfo
Public Methods
 MethodDefined By
  
DashletInfo
  
fromPersistenceString(string:String, userSettingsOptions:UserSettingsOptions):void
Loads property values from the passed in string after parsing through it.
DashletInfo
  
toPersistenceString(userSettingsOptions:UserSettingsOptions):String
Converts to a string for ease of persistence.
DashletInfo
Property Detail
dashletIdentifierproperty
public var dashletIdentifier:String

The uniqueIdentifier for the dashlet

hasTitleBarproperty 
public var hasTitleBar:Boolean

Whether the dashet is showing the title bar

heightproperty 
public var height:Number

The height from the dimensions array

isCollapsedproperty 
public var isCollapsed:Boolean

Whether the dashet is collapsed

isHeightPercentproperty 
public var isHeightPercent:Boolean

Whether the height is in percentage

isMinimizedproperty 
public var isMinimized:Boolean

Whether the dashet is minimized to the the task bar

isOpenproperty 
public var isOpen:Boolean

Whether the dashet is open

isWidthPercentproperty 
public var isWidthPercent:Boolean

Whether the width is in percentage

widthproperty 
public var width:Number

The width from the dimensions array

xproperty 
public var x:Number

The x from the dimensions array

yproperty 
public var y:Number

The y from the dimensions array

zoneElementIndexproperty 
public var zoneElementIndex:int

The element index of this dashlet within the zone

zoneIdentifierproperty 
public var zoneIdentifier:String

The uniqueIdentifier for the zone

Constructor Detail
DashletInfo()Constructor
public function DashletInfo()



Method Detail
fromPersistenceString()method
public function fromPersistenceString(string:String, userSettingsOptions:UserSettingsOptions):void

Loads property values from the passed in string after parsing through it.

Parameters

string:String
 
userSettingsOptions:UserSettingsOptions

toPersistenceString()method 
public function toPersistenceString(userSettingsOptions:UserSettingsOptions):String

Converts to a string for ease of persistence.

Parameters

userSettingsOptions:UserSettingsOptions

Returns
String