| dtw.webmail.model.JwmaHtmlHelper
All known Subclasses: dtw.webmail.model.JwmaHtmlHelperImpl,
| JwmaHtmlHelper | | public interface JwmaHtmlHelper (Code) | | An interface defining the contract for interaction with
the JwmaHtmlHelper model.
The JwmaHtmlHelper helps a view programmer constructing
certain reuseable HTML elements on one hand, and to obtain
information important for views on the other hand (i.e.
the controller URL).
author:
Dieter Wimberger
version:
0.9.7 07/02/2003 |
| Method Summary | |
| public String | displayPartInlined(HttpSession session, JwmaMessagePart part, JwmaPreferences prefs, ResourceBundle viewcontent)
Returns a String representing a
HTML tag for embedding the message parts into
the view.
This routine constructs an inline view of all
given message parts in HTML. | | public String | getAlphabeticFilter(JwmaContacts contacts, ResourceBundle viewcontent)
Returns a String representing a HTML
list of all first characters of the contact's lastnames.
The selected character will be used for the filter,
as well as displayed non-selectable; an option to remove
the filter is appended (ALL).
Parameters:
contacts - the actual session's contact database asJwmaContacts.
Parameters:
viewcontent - the ResourceBundle containing thelocalized view content strings. | | public String | getCategoriesSelect(JwmaContact ct, String[] categories, ResourceBundle viewcontent)
Returns a String representing a
category select in HTML.
This routine constructs a select with all given
categories for the view programmer,
and is supposed to be used for selecting a
(user defined) category for a contact.
If the user did not define any category, the
select will only have the new category option.
Parameters:
contact - the JwmaContact instance.
Parameters:
categories - the categories to be listed as options.
Parameters:
viewcontent - the ResourceBundle containing thelocalized view content strings. | | public String | getCategoryFilterSelect(JwmaContacts ctdb, String eventhandler, ResourceBundle viewcontent)
Returns a String representing a
category filter select in HTML.
This routine constructs a select with all used
categories.
Parameters:
contacts - the actual session's contact database asJwmaContacts.
Parameters:
eventhandler - added to the select.
Parameters:
viewcontent - the ResourceBundle containing thelocalized view content strings. | | public String | getContactsControllerUrl()
Returns a String representing the URL
of the ContactsController. | | public String | getControllerUrl()
Returns a String representing the URL
of the main controller. | | public String | getDateFormatSelect(JwmaPreferences prefs)
Returns a String representing a
DateFormat select in HTML.
This routine constructs a select with date format
patterns, with the user's one selected.
Parameters:
prefs - the users preferences as JwmaPreferences. | | public String | getDestinationsSelect(JwmaFolder[] folders)
Returns a JwmaFolder[]containing a
destination select in HTML.
This routine constructs a select with all given
paths for the view programmer, and is supposed
to be used for selecting a destination for certain
folder, mailbox or message move operations.
Lists of paths of move targets can be obtained from
JwmaStoreInfo.
Parameters:
folders - a JwmaFolder[] to be used asoptions for the select. | | public String | getFolderDisplayAction(JwmaFolder folder)
Returns a String representing the
installation specific reference URL for displaying
the given folder.
The String will not include the anchor tag, but
represent the href attribute value.
This method is supposed to help making views more
portable and simple to write.
Parameters:
folder - the JwmaFolder to be used for thedisplay action. | | public String | getFolderDisplayAction(JwmaInboxInfo info)
Convenience method returning the URL for displaying
the inbox folder.
Parameters:
folder - the JwmaFolder to be used for thedisplay action. | | public String | getFolderDisplayAction(JwmaTrashInfo info)
Convenience method returning the URL for displaying
the trash folder.
Parameters:
folder - the JwmaFolder to be used for thedisplay action. | | public String | getFrequentSelect(JwmaContacts contacts, String eventhandler)
Returns a String representing a
frequent recipient select in HTML.
This routine constructs a select with all given
frequent recipient nicks for the view programmer,
and is supposed to be used for selecting a
frequent recipient very quick.
Parameters:
contacts - the JwmaContacts instance.
Parameters:
eventhandler - added to the select. | | public String | getGroupMembersSelect(JwmaContactGroup group)
Returns a String representing a
group members select in HTML.
This routine constructs a select with all
contacts which are in the given contact group.
Parameters:
group - the JwmaContactGroup instance. | | public String | getLanguageSelect(JwmaPreferences prefs)
Returns a String representing a
proper language select in HTML.
This routine constructs a select with all available
languages.
Parameters:
prefs - the users preferences as JwmaPreferences. | | public String | getMailIdentitySelect(JwmaPreferences prefs)
Returns a String representing a
MailIdentity select in HTML.
This routine constructs a select with the users available
mail identities, the default selected.
Parameters:
prefs - the users preferences as JwmaPreferences. | | public String | getMessageProcessorSelect(JwmaPreferences prefs)
Returns a String representing a
MessageProcessor select in HTML.
This routine constructs a select with the available
message processors, with the user's one selected.
Parameters:
prefs - the users preferences as JwmaPreferences. | | public String | getNonMembersSelect(JwmaContactGroup group, JwmaContacts ctdb)
Returns a String representing a
non group members select in HTML.
This routine constructs a select with all
contacts which are not in the given contact group.
Parameters:
group - the JwmaContactGroup instance.
Parameters:
ctdb - the contact database. | | public String | getPartDescription(JwmaMessagePart part, ResourceBundle viewcontent)
Returns a String representing a
message part description in HTML.
This routine constructs a description with all given
information about the part for the view programmer,
and is supposed to simplify writing a view.
Parameters:
part - the part to be described in HTML.
Parameters:
viewcontent - the ResourceBundle containing thelocalized view content strings. | | public String | getPathHierarchyNavigator(JwmaStoreInfo storeinfo, JwmaFolder folder)
Returns a String representing a
path navigator in HTML.
This routine allows to navigate a more complex
folder tree very fast and efficient. | | public String | getPostOfficeSelect(String postoffice)
Returns a selection of configured post offices. | | public String | getRandomAppendTypesSelect(JwmaPreferences prefs, JwmaMailIdentity mid)
Returns a String representing a
random append types select in HTML.
This routine constructs a select with the available
random append types, with the user's one selected.
Parameters:
prefs - the users preferences as JwmaPreferences.
Parameters:
mid - a JwmaMailIdentity instance. | | public String | getSendMailControllerUrl()
Returns a String representing the URL
of the SendMailController. | | public String | getSizeString(int size)
Returns a String representing the size
in human readable form.
Parameters:
size - the size (in bytes) to be described inhuman readable form. | | public String | getSortCriteriaSelect(JwmaPreferences prefs, String eventhandler, ResourceBundle viewcontent)
Returns a String representing a
proper sorting criteria select in HTML.
This routine constructs a select with all available
message sorting criterias.
Parameters:
prefs - the users preferences as JwmaPreferences.
Parameters:
eventhandler - added to the select.
Parameters:
viewcontent - the ResourceBundle containing thelocalized view content strings. |
| getAlphabeticFilter | | public String getAlphabeticFilter(JwmaContacts contacts, ResourceBundle viewcontent)(Code) | | Returns a String representing a HTML
list of all first characters of the contact's lastnames.
The selected character will be used for the filter,
as well as displayed non-selectable; an option to remove
the filter is appended (ALL).
Parameters:
contacts - the actual session's contact database asJwmaContacts.
Parameters:
viewcontent - the ResourceBundle containing thelocalized view content strings. the filter list as String (HTML). |
| getCategoriesSelect | | public String getCategoriesSelect(JwmaContact ct, String[] categories, ResourceBundle viewcontent)(Code) | | Returns a String representing a
category select in HTML.
This routine constructs a select with all given
categories for the view programmer,
and is supposed to be used for selecting a
(user defined) category for a contact.
If the user did not define any category, the
select will only have the new category option.
Parameters:
contact - the JwmaContact instance.
Parameters:
categories - the categories to be listed as options.
Parameters:
viewcontent - the ResourceBundle containing thelocalized view content strings. a categories select (HTML) as String.
See Also: dtw.webmail.model.JwmaContacts |
| getCategoryFilterSelect | | public String getCategoryFilterSelect(JwmaContacts ctdb, String eventhandler, ResourceBundle viewcontent)(Code) | | Returns a String representing a
category filter select in HTML.
This routine constructs a select with all used
categories.
Parameters:
contacts - the actual session's contact database asJwmaContacts.
Parameters:
eventhandler - added to the select.
Parameters:
viewcontent - the ResourceBundle containing thelocalized view content strings. a sorting criteria select (HTML) as String. |
| getContactsControllerUrl | | public String getContactsControllerUrl()(Code) | | Returns a String representing the URL
of the ContactsController.
The URL is installation specific, this helper method
allows to make views more "portable".
the URL of the ContactsController as String. |
| getControllerUrl | | public String getControllerUrl()(Code) | | Returns a String representing the URL
of the main controller.
The URL is installation specific, this helper method
allows to make views more "portable".
the URL of the main controller as String. |
| getDateFormatSelect | | public String getDateFormatSelect(JwmaPreferences prefs)(Code) | | Returns a String representing a
DateFormat select in HTML.
This routine constructs a select with date format
patterns, with the user's one selected.
Parameters:
prefs - the users preferences as JwmaPreferences. a date format select (HTML) as String. |
| getFolderDisplayAction | | public String getFolderDisplayAction(JwmaFolder folder)(Code) | | Returns a String representing the
installation specific reference URL for displaying
the given folder.
The String will not include the anchor tag, but
represent the href attribute value.
This method is supposed to help making views more
portable and simple to write.
Parameters:
folder - the JwmaFolder to be used for thedisplay action. the URL for displaying the folder as String.
See Also: dtw.webmail.model.JwmaFolder |
| getFrequentSelect | | public String getFrequentSelect(JwmaContacts contacts, String eventhandler)(Code) | | Returns a String representing a
frequent recipient select in HTML.
This routine constructs a select with all given
frequent recipient nicks for the view programmer,
and is supposed to be used for selecting a
frequent recipient very quick.
Parameters:
contacts - the JwmaContacts instance.
Parameters:
eventhandler - added to the select. a frequent recipient select (HTML) as String.
See Also: dtw.webmail.model.JwmaContacts |
| getGroupMembersSelect | | public String getGroupMembersSelect(JwmaContactGroup group)(Code) | | Returns a String representing a
group members select in HTML.
This routine constructs a select with all
contacts which are in the given contact group.
Parameters:
group - the JwmaContactGroup instance. a group members select (HTML) as String.
See Also: dtw.webmail.model.JwmaContactGroup |
| getLanguageSelect | | public String getLanguageSelect(JwmaPreferences prefs)(Code) | | Returns a String representing a
proper language select in HTML.
This routine constructs a select with all available
languages.
Parameters:
prefs - the users preferences as JwmaPreferences. a language select (HTML) as String. |
| getMailIdentitySelect | | public String getMailIdentitySelect(JwmaPreferences prefs)(Code) | | Returns a String representing a
MailIdentity select in HTML.
This routine constructs a select with the users available
mail identities, the default selected.
Parameters:
prefs - the users preferences as JwmaPreferences. a mail identity select (HTML) as String. |
| getMessageProcessorSelect | | public String getMessageProcessorSelect(JwmaPreferences prefs)(Code) | | Returns a String representing a
MessageProcessor select in HTML.
This routine constructs a select with the available
message processors, with the user's one selected.
Parameters:
prefs - the users preferences as JwmaPreferences. a message processor select (HTML) as String. |
| getPartDescription | | public String getPartDescription(JwmaMessagePart part, ResourceBundle viewcontent)(Code) | | Returns a String representing a
message part description in HTML.
This routine constructs a description with all given
information about the part for the view programmer,
and is supposed to simplify writing a view.
Parameters:
part - the part to be described in HTML.
Parameters:
viewcontent - the ResourceBundle containing thelocalized view content strings. a message part description (HTML) as String.
See Also: dtw.webmail.model.JwmaMessagePart |
| getPathHierarchyNavigator | | public String getPathHierarchyNavigator(JwmaStoreInfo storeinfo, JwmaFolder folder)(Code) | | Returns a String representing a
path navigator in HTML.
This routine allows to navigate a more complex
folder tree very fast and efficient. It handles
the path using the actual folder separator char.
Parameters:
storeinfo - a reference to the actual store info instance.
Parameters:
path - the path to be translated into a navigator. a path navigator (HTML) as String. |
| getRandomAppendTypesSelect | | public String getRandomAppendTypesSelect(JwmaPreferences prefs, JwmaMailIdentity mid)(Code) | | Returns a String representing a
random append types select in HTML.
This routine constructs a select with the available
random append types, with the user's one selected.
Parameters:
prefs - the users preferences as JwmaPreferences.
Parameters:
mid - a JwmaMailIdentity instance. a random append type select (HTML) as String. |
| getSendMailControllerUrl | | public String getSendMailControllerUrl()(Code) | | Returns a String representing the URL
of the SendMailController.
The URL is installation specific, this helper method
allows to make views more "portable".
the URL of the SendMailController as String. |
| getSizeString | | public String getSizeString(int size)(Code) | | Returns a String representing the size
in human readable form.
Parameters:
size - the size (in bytes) to be described inhuman readable form. the human readable size as String. |
| getSortCriteriaSelect | | public String getSortCriteriaSelect(JwmaPreferences prefs, String eventhandler, ResourceBundle viewcontent)(Code) | | Returns a String representing a
proper sorting criteria select in HTML.
This routine constructs a select with all available
message sorting criterias.
Parameters:
prefs - the users preferences as JwmaPreferences.
Parameters:
eventhandler - added to the select.
Parameters:
viewcontent - the ResourceBundle containing thelocalized view content strings. a sorting criteria select (HTML) as String. |
|
|