List of properties
Property name | Description |
---|---|
viewFile | The name of .swf file that contains appropriate user interface. |
view | An object provides an access to properties of loaded user interface. |
configFile | The name of xml configuration file. |
overlayModePlaceholder | The name of html element that will be used as a placeholder of transparent flash movie. |
activeLanguage | The name of active language that detrmines what kind of texts will be used for user interface. |
dateFormatString | The string pattern for DateTime values formatting. |
daysAbbrev | The string array contains the names abbreviations of the days of the week. |
fullDays | The string array contains the names of the days of the week. |
monthsAbbrev | The string array contains the names abbreviations of the months of the year. |
fullMonths | The string array contains the names of the months of the year. |
sizeAbbrev | The string array contains the names abbreviations of the size unit. |
timeAbbrev | The string array contains the names abbreviations of the time unit. |
showRotator | Indicates whether or not loading indicator should be displayed. |
viewFile
Default value: none
Type: string
String reference: "viewFile"
Description:
The name of .swf file that contains appropriate user interface. EAFlashUpload includes four types of user interface (TableView.swf, ListView.swf, ShortView.swf, ImageView.swf). EAFUpload.swf doesn't have user interface but can load it from the file that specified by this property. The names of the files can be changed for your needs.
Here is a main differences among provided user interfaces.
- TableView.swf - visual list of files is represented as a table with possibility customizing of collumns.
- ListView.swf - visual list of files is represented as a list control.
- ShortView.swf - visual list of files doesn't exist.
- ImageView.swf - visual list is presented as table of thumbnails. This view was developed especially for image upload solutions.
The value of property is assigned via flashvars object of SWFObject:
flashvars["viewFile"] = "TableView.swf";
view
Default value: none
Type: Object
String reference: "view"
Description:
The objects provides an access to properties of loaded user interface. The EAFlashUpload includes four types of user interface (TableView, ListView, ShortView, ImageView.swf). See decription of existing properties in the appropriate interface description.
Examples:The value of backgrond property of the TableView interface is assigned via flashvars object of SWFObject:
flashvars["viewFile"] = "TableView.swf"; // background is drew with gradient. flashvars["view.backgroundColor"] = "#000000|#ffffff";
configFile
Default value: none
Type: string
String reference: "configFile"
Description:
The name of xml file that contains configuration of EAFlashUpload component. EAFlashUpload can be fully configured via xml. Syntax and tags description you can find in the Configuration section. If you define full configuration in the xml file then "configFile" property should be defined on the page.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["configFile"] = "configuration.xml";
overlayModePlaceholder
Default value: none
Type: string
String reference: "overlayModePlaceholder"
Description:
The name of html element that will be used as a placeholder of transparent flash movie. The Flash Player 10 has a security restriction: "Browse Dialog" cannot be open without user interaction with flash object. If overlayModePlaceholder property set the EAFlashUpload will be created as a transparent movie and will be placed over specified html element. JavaScript DOM is used for overlay placeholder. Overlay mode was created for creating "pure" JavaScript + DHTML user interface. There are two important points: wmode parameter should be set to "transparent" and style attribute position should be set "absolute".
In the overlay mode EAFUpload.swf is used only and viewFile property should be omitted.
Examples:
The value of property is assigned via flashvars object of SWFObject. After movie will be loaded on the page it is placed over specified html element with "OverlayPlaceholder" id:
<html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>JavaScript interface</title> <script type="text/javascript" src="swfobject.js"></script> </head> <body> <div id="EAFlashUpload_holder">Alternate content</div> <a id="OverlayPlaceholder">Browse files</a> <script type="text/javascript"> var params = { wmode: "transparent" }; var attributes = { id: "EAFlashUpload", name: "EAFlashUpload", style: "position: absolute;" }; var flashvars = new Object(); flashvars["uploader.uploadUrl"] = "uploadfiles.php"; flashvars["overlayModePlaceholder"] = "OverlayPlaceholder"; swfobject.embedSWF("EAFUpload.swf", "EAFlashUpload_holder", "100", "100", "9.0.0", "expressInstall.swf", flashvars, params, attributes); </script> ... </body> </html>
activeLanguage
Default value: "eng"
Type: string
String reference: "activeLanguage"
Description:
The name of active language that determines what kind of texts will be used for user interface. The EAFlashUpload has a flexible localization behavior. Via XML configuration file you can define texts of buttons, messages etc. for as languages as you need for you solution.
Examples:
The value of property is assigned via xml configuration file:
<EAFlashUpload activeLanguage="spanish"> <localization> <eng .... view.addButton.label="Choose files" /> <spanish .... view.addButton.label="Elegir los files" /> </localization> ... </EAFlashUpload>
dateFormatString
Default value: "d/m/Y H:i"
Type: string
String reference: "dateFormatString"
Description:
The string pattern for DateTime values formatting. The following table describes list of symbols which can be included to the pattern:
Symbol | Description | Example returned values |
---|---|---|
a | Lowercase Ante meridiem and Post meridiem | am or pm |
A | Uppercase Ante meridiem and Post meridiem | AM or PM |
d | Day of the month, 2 digits with leading zeros | 01 to 31 |
D | Textual representation of a day, three letters | Mon through Sun* |
F | Full textual representation of a month | January through December* |
g | 12-hour format of an hour without leading zeros | 1 through 12 |
G | 24-hour format of an hour without leading zeros | 0 through 23 |
h | 12-hour format of an hour with leading zeros | 01 through 12 |
H | 24-hour format of an hour with leading zeros | 00 through 23 |
i | Minutes with leading zeros | 00 to 59 |
j | Day of the month without leading zeros | 1 to 31 |
l | Full textual representation of the day of the week (lowercase 'L') | Sunday through Saturday* |
L | Whether it's a leap year | 1 if it is a leap year, 0 otherwise |
m | Numeric representation of a month, with leading zeros | 01 through 12 |
M | Short textual representation of a month, three letters | Jan through Dec* |
n | Numeric representation of a month, without leading zeros | 1 through 12 |
O | Difference to Greenwich time (GMT) in hours | Example: 5 (for EST ) |
s | Seconds, with leading zeros | 00 throguh 59 |
t | Number of days in the given month | 28 through 31 |
U | Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) | |
w | Numeric representation of the day of the week | 0 (for Sunday) through 6 (for Saturday) |
Y | Full numeric representation of a year, 4 digits | Examples: 1999 or 2003 |
y | Two digit representation of a year | Examples: 99 or 03 |
The value of property is assigned via flashvars object of SWFObject:
flashvars["dateFormatString"] = "d/m/Y H:i";
daysAbbrev
Default value: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"]
Type: Array
String reference: "daysAbbrev"
Description:
The string array contains the names abbreviations of the days of the week. This property is used for date time values formatting. You can define different abbreviations for different languages.
Examples:The value of property is assigned via flashvars object of SWFObject:
flashvars["daysAbbrev"] = "Sun|Mon|Tue|Wed|Thu|Fri|Sat";
fullDays
Default value: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
Type: Array
String reference: "fullDays"
Description:
The string array contains full textual representation of the days of the week. This property is used for date time values formatting. You can define different texts for different languages.
Examples:The value of property is assigned via flashvars object of SWFObject:
flashvars["fullDays"] = "Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday";
monthsAbbrev
Default value: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
Type: Array
String reference: "monthsAbbrev"
Description:
The string array contains the names abbreviations of the months of the year. This property is used for date time values formatting. You can define different abbreviations for different languages.
Examples:The value of property is assigned via flashvars object of SWFObject:
flashvars["monthsAbbrev"] = "Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec";
fullMonths
Default value: ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"]
Type: Array
String reference: "fullMonths"
Description:
The string array contains full textual representation of the months of the year. This property is used for date time values formatting. You can define different texts for different languages.
Examples:The value of property is assigned via flashvars object of SWFObject:
flashvars["fullMonths"] = "January|February|March|April|May|June|July|August|September|October|November|December";
sizeAbbrev
Default value: [" B", " KB", " MB", " GB"]
Type: Array
String reference: "sizeAbbrev"
Description:
The string array contains the names abbreviations of the size unit. This property is used for size values formatting. You can define different abbreviations for different languages.
Examples:The value of property is assigned via flashvars object of SWFObject:
flashvars["sizeAbbrev"] = " B| KB| MB| GB";
timeAbbrev
Default value: [" h", " m", " s]
Type: Array
String reference: "timeAbbrev"
Description:
The string array contains the names abbreviations of the time unit. This property is used for time values formatting. You can define different abbreviations for different languages.
Examples:The value of property is assigned via flashvars object of SWFObject:
flashvars["timeAbbrev"] = " h| m| s";
showRotator
Default value: true
Type: Boolean
String reference: "showRotator"
Description:
Indicates whether or not loading indicator should be displayed. The rotator is displayed while all content of EAFlashUpload control will not be loaded (loading of UI may take some time on slow intenet connections). This property should be defined on the page via flashvars object of SWFObject or via <object>/<embed> objects. The rotator does not displayed if overlayModePlaceholder property has a value.
Examples:The value of property is assigned via flashvars object of SWFObject:
flashvars["showRotator"] = true;