com.waveset.ui
Class EditForm.HelpRef

java.lang.Object
  extended bycom.waveset.ui.EditForm.HelpRef
Enclosing class:
EditForm

public static class EditForm.HelpRef
extends java.lang.Object

A base class for all of the various editing items that can appear in a form.

The "name" of an item, is the name that will appear in the HTML as the name attribute of the corresponding element, it is the thing you look for when you sift through the post data.

The "title" of an item is the text that is displayed to the left of the editing region. If an item has no title, it is displayed to the right of the last item, rather than on a new line. Might need more control here...

All items should have a title. Some, like Label, may not have a meaningful name.

Most items also have a single value, which is represented as string. Some complex items may not use the value field.

Added a reqired flag so we have the option to add some visual prominance to required fields.


Field Summary
static int ITEM_LEVEL_HELP
           
static int TOOLTIP
           
 
Constructor Summary
EditForm.HelpRef(int type, java.lang.String key)
           
EditForm.HelpRef(int type, java.lang.String key, java.lang.String imageURL)
           
 
Method Summary
 PageInformation getPageInformation()
           
 void setPageInformation(PageInformation pi)
           
 java.lang.String toHTML(java.lang.String label, Session session)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TOOLTIP

public static final int TOOLTIP
See Also:
Constant Field Values

ITEM_LEVEL_HELP

public static final int ITEM_LEVEL_HELP
See Also:
Constant Field Values
Constructor Detail

EditForm.HelpRef

public EditForm.HelpRef(int type,
                        java.lang.String key,
                        java.lang.String imageURL)

EditForm.HelpRef

public EditForm.HelpRef(int type,
                        java.lang.String key)
Method Detail

setPageInformation

public void setPageInformation(PageInformation pi)

getPageInformation

public PageInformation getPageInformation()

toHTML

public java.lang.String toHTML(java.lang.String label,
                               Session session)