Editor
implements GuiElement| com.microstrategy.web.app.gui.Editor |
 Known Indirect Subclasses
|
Class Overview
Title: Editor.
Description: interface for the editor components in Microstrategy Web.
The Editor GUI Element is responsible for producing a dialog like interface
used by all the editors in the application. Its properties and methods
allow the user to quiclky generate a dialog that follows the look and feel
standards of Microstrategy Web. Instances of this interface are used by the
AbstractEditorTransform
to generate the application dialogs, but its usage is
not limited to transform as any object capable of handling a MarkupOutput
can use this component.
Instances to this component must be obtained through the GuiElementFactory.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | APPLY_BUTTON | The property value of the Apply button | |||||||||
| int | CANCEL_BUTTON | The property value of the Cancel button | |||||||||
| int | OK_BUTTON | The property value of the OK button | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
appendDisplayFlag(int flag)
append some display flag
| ||||||||||
| abstract Tag |
getActionButtonsBar()
Returns the TR tag that will be used to render the action buttons bar
| ||||||||||
| abstract WebEvent |
getApplyEvent()
get the apply event for the editor
| ||||||||||
| abstract String |
getApplyJS()
Indicates JavaScript to be executed when applying changes current Editor.
| ||||||||||
| abstract boolean |
getCanAutoSize()
Returns true if the editor can auto size to show its contents
| ||||||||||
| abstract WebEvent |
getCancelEvent()
get the cancel event for the editor
| ||||||||||
| abstract String |
getCancelJS()
Indicates JavaScript to be executed when canceling current Editor.
| ||||||||||
| abstract WebEvent |
getCloseEvent()
get the close event for the editor
| ||||||||||
| abstract String |
getCloseJS()
Indicates JavaScript to be executed when closing current Editor.
| ||||||||||
| abstract MarkupOutput |
getContents()
Returns the content of the editor.
| ||||||||||
| abstract int |
getDisplayFlags()
get the display flag for the editor
| ||||||||||
| abstract WebEvent |
getHelpEvent()
This method is deprecated.
use
getHelpType()
| ||||||||||
| abstract String |
getHelpToolTip()
get the tooltip of the editor
| ||||||||||
| abstract String |
getHelpType()
get the type of the help file
| ||||||||||
| abstract WebEvent |
getOkEvent()
get the ok event for the editor
| ||||||||||
| abstract String |
getOkJS()
Indicates JavaScript to be executed when clicking 'OK' button in current Editor.
| ||||||||||
| abstract MarkupOutput |
getPostButtonContents()
get the content after the apply/ok/cancel buttons
| ||||||||||
| abstract String |
getTitle()
get the title of the editor
| ||||||||||
| abstract MarkupOutput |
getTitleElements()
get the title elements of the editor
| ||||||||||
| abstract boolean |
getUseDHTMLForEditorClose()
Returns true if we want to use DHTML code to close the editor
| ||||||||||
| abstract boolean |
hasSpaceAfterEditor()
whethere display a blank space underneath the editor
| ||||||||||
| abstract boolean |
isHideFocus()
gets the hide focus property of the buttons in the editor
| ||||||||||
| abstract void |
renderCloseButton(MarkupOutput out, WebEvent closeEvent, String closeJS)
Renders the close button for an editor
| ||||||||||
| abstract MarkupOutput |
renderElement(String cssClass)
render the gui element in a MarkupOutput object
| ||||||||||
| abstract void |
renderHelpButton(MarkupOutput out, WebEvent helpEvent, String helpTopic)
This method is deprecated.
use
renderHelpButton(MarkupOutput)
| ||||||||||
| abstract void |
renderHelpButton(MarkupOutput out)
Renders the help button for an editor.
| ||||||||||
| abstract void |
setActionButtonsBar(Tag ab)
Sets the TR tag that will be used to render the action buttons bar
| ||||||||||
| abstract void |
setApplyEvent(WebEvent event)
set the apply event for the editor
| ||||||||||
| abstract void |
setApplyJS(String value)
Specifies JavaScript function to be invoked when applying changes for Editor in DHTML mode only.
| ||||||||||
| abstract void |
setApplyLabel(String applyLabel)
set the apply label, which is displayed as the text of the apply button
| ||||||||||
| abstract void |
setApplyTooltip(String applyTooltip)
set the apply tooltip, which is displayed as the text of the apply button
| ||||||||||
| abstract void |
setAttribute(String attributeName, String value, int location)
Set attributes on the location specified (EnumEditorSectionTypes.EditorMainDiv, EnumEditorSectionTypes.EditorTitleDiv, EnumEditorSectionTypes.EditorBodyDiv).
| ||||||||||
| abstract void |
setButtonDisabled(int button, boolean disableValue)
Set the disabled property of the specified button.
| ||||||||||
| abstract void |
setButtonsCss(String css)
set the button css class name for the editor
| ||||||||||
| abstract void |
setCanAutoSize(boolean value)
Set to true if the editor can auto size to show its contents
| ||||||||||
| abstract void |
setCancelEvent(WebEvent event)
set the cancel event for the editor
| ||||||||||
| abstract void |
setCancelJS(String value)
Specifies JavaScript function to be invoked when canceling Editor in DHTML mode only.
| ||||||||||
| abstract void |
setCancelLabel(String cancelLabel)
set the cancel label, which is displayed as the text of the cancel button
| ||||||||||
| abstract void |
setCancelTooltip(String cancelLabel)
set the cancel tooltip, which is displayed as the text of the cancel button
| ||||||||||
| abstract void |
setCloseEvent(WebEvent event)
set the close event for the editor
| ||||||||||
| abstract void |
setCloseJS(String value)
Specifies JavaScript function to be invoked when closing Editor in DHTML mode only.
| ||||||||||
| abstract void |
setCloseLabel(String closeLabel)
set the close label, which is displayed as the tooltip of the close icon
| ||||||||||
| abstract void |
setContents(MarkupOutput out)
This method is deprecated.
Don't create a MarkupOutput and create it, instead call
getContents
and populate this instance.
| ||||||||||
| abstract void |
setContentsCss(String css)
set the content css class name for the editor
| ||||||||||
| abstract void |
setCssPrefix(String value)
Set the cssPrefix for the editor container
| ||||||||||
| abstract void |
setDisplayFlags(int flags)
set the display flag for the editor
| ||||||||||
| abstract void |
setEditorDefinitionLayout(String fileName)
Sets the definition layout for the editor.
| ||||||||||
| abstract void |
setExtraProperties(MarkupOutput mo)
This method is deprecated.
replaced by
setAttribute(String, String, int)
| ||||||||||
| abstract void |
setForm(String action, String method, String formName, String extraAttributes, String onSubmitInfo)
set the form information for the editor
| ||||||||||
| abstract void |
setForm(String action, String method, String formName, String extraAttributes)
set the form information for the editor
| ||||||||||
| abstract void |
setForm(String action, String method, String formName)
set the form information for the editor
| ||||||||||
| abstract void |
setFormId(String value)
Set the if of the form to use in XHR partial update
| ||||||||||
| abstract void |
setGlobalContentCss(String css)
set the global content css class name for the editor
| ||||||||||
| abstract void |
setGlobalCss(String css)
set the global css class name for the editor
| ||||||||||
| abstract void |
setHelpEvent(WebEvent event)
This method is deprecated.
use
setHelpType(String)
| ||||||||||
| abstract void |
setHelpLabel(String helpLabel)
set the help label, which is displayed as the tooltip of the help icon
| ||||||||||
| abstract void |
setHelpToolTip(String title)
set the tooltip of the editor
| ||||||||||
| abstract void |
setHelpTopic(String topic)
set the help topic of the editor
| ||||||||||
| abstract void |
setHelpType(String type)
set the help type for the editor
| ||||||||||
| abstract void |
setHideFocus(boolean value)
set the hide focus property of the buttons in the editor
| ||||||||||
| abstract void |
setImageBasePath(String path)
Set the folder path to be used as base for all the images to use while displaying menus
| ||||||||||
| abstract void |
setOKLabel(String OKLabel)
set the ok label, which is displayed as the text of the ok button
| ||||||||||
| abstract void |
setOKTooltip(String OKLabel)
set the ok tooltip, which is displayed as the text of the ok button
| ||||||||||
| abstract void |
setOkEvent(WebEvent event)
set the ok event for the editor
| ||||||||||
| abstract void |
setOkJS(String value)
Specifies JavaScript function to be invoked when pressing Editor's 'OK' button in DHTML mode only.
| ||||||||||
| abstract void |
setPostButtonContents(MarkupOutput out)
set the content after the apply/ok/cancel buttons
| ||||||||||
| abstract void |
setSpaceAfterEditor(boolean spaceAfterEditor)
Set whethere display a blank space underneath the editor
| ||||||||||
| abstract void |
setTitle(String title)
set the title of the editor
| ||||||||||
| abstract void |
setTitleCss(String css)
set the title css class name for the editor
| ||||||||||
| abstract void |
setTitleElements(MarkupOutput out)
set the title elements of the editor
| ||||||||||
| abstract void |
setTitleElementsCss(String css)
set the title elements' css class name for the editor
| ||||||||||
| abstract void |
setUseDHTMLForEditorClose(boolean value)
Set to true if we want to use DHTML code to close the editor
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.web.app.gui.GuiElement
| |||||||||||
Constants
public static final int APPLY_BUTTON
The property value of the Apply button
public static final int CANCEL_BUTTON
The property value of the Cancel button
public static final int OK_BUTTON
The property value of the OK button
Public Methods
public abstract void appendDisplayFlag (int flag)
append some display flag
Parameters
| flag | the flag to append |
|---|
public abstract Tag getActionButtonsBar ()
Returns the TR tag that will be used to render the action buttons bar
public abstract WebEvent getApplyEvent ()
get the apply event for the editor
Returns
- the apply event
public abstract String getApplyJS ()
Indicates JavaScript to be executed when applying changes current Editor.
Returns
- String JS function
public abstract boolean getCanAutoSize ()
Returns true if the editor can auto size to show its contents
Returns
- true if the editor can auto size to show its contents
public abstract WebEvent getCancelEvent ()
get the cancel event for the editor
Returns
- the cancel event
public abstract String getCancelJS ()
Indicates JavaScript to be executed when canceling current Editor.
Returns
- String JS function
public abstract WebEvent getCloseEvent ()
get the close event for the editor
Returns
- the close event
public abstract String getCloseJS ()
Indicates JavaScript to be executed when closing current Editor.
Returns
- String JS function
public abstract MarkupOutput getContents ()
Returns the content of the editor. This is the MarkupOutput clients users should manipulate to generate the body of the editor.
Returns
- the content as a
MarkupOutputobject used for the body section
public abstract int getDisplayFlags ()
get the display flag for the editor
Returns
- the display flag
public abstract WebEvent getHelpEvent ()
This method is deprecated.
use getHelpType()
get the help event for the editor
Returns
- the help event
public abstract String getHelpToolTip ()
get the tooltip of the editor
Returns
- the tooltip of the editor
public abstract String getHelpType ()
get the type of the help file
Returns
- the type is one of
HELP_TYPE_ADMIN,HELP_TYPE_USER,HELP_TYPE_CUSTOM
public abstract String getOkJS ()
Indicates JavaScript to be executed when clicking 'OK' button in current Editor.
Returns
- String JS function
public abstract MarkupOutput getPostButtonContents ()
get the content after the apply/ok/cancel buttons
Returns
- the content as a
MarkupOutputobject
public abstract String getTitle ()
get the title of the editor
Returns
- the title of the editor
public abstract MarkupOutput getTitleElements ()
get the title elements of the editor
Returns
- the title elements as a
MarkupOutputobject
public abstract boolean getUseDHTMLForEditorClose ()
Returns true if we want to use DHTML code to close the editor
Returns
- true if we want to use DHTML code to close the editor
public abstract boolean hasSpaceAfterEditor ()
whethere display a blank space underneath the editor
Returns
- whethere display a blank space underneath the editor
public abstract boolean isHideFocus ()
gets the hide focus property of the buttons in the editor
Returns
- the value of the hide focus property
public abstract void renderCloseButton (MarkupOutput out, WebEvent closeEvent, String closeJS)
Renders the close button for an editor
Parameters
| out | MarkupOutput where the button will be generated |
|---|---|
| closeEvent | WebEvent the event to use to close the editor |
| closeJS | an optional String, if not empty it would be used as the value of the onclick if DHTML is enabled. |
public abstract MarkupOutput renderElement (String cssClass)
render the gui element in a MarkupOutput object
Parameters
| cssClass | the css class of target object |
|---|
Returns
- the
MarkupOutputobject
public abstract void renderHelpButton (MarkupOutput out, WebEvent helpEvent, String helpTopic)
This method is deprecated.
use renderHelpButton(MarkupOutput)
Renders the help button for an editor.
Parameters
| out | MarkupOutput where the help will be generated |
|---|---|
| helpEvent | WebEvent the help event to use |
| helpTopic | String the associated help topic with this editor. |
public abstract void renderHelpButton (MarkupOutput out)
Renders the help button for an editor.
Parameters
| out | MarkupOutput where the help will be generated |
|---|
public abstract void setActionButtonsBar (Tag ab)
Sets the TR tag that will be used to render the action buttons bar
public abstract void setApplyEvent (WebEvent event)
set the apply event for the editor
Parameters
| event | the apply event |
|---|
public abstract void setApplyJS (String value)
Specifies JavaScript function to be invoked when applying changes for Editor in DHTML mode only.
Parameters
| value | String Array consisted of function name and parameters. |
|---|
public abstract void setApplyLabel (String applyLabel)
set the apply label, which is displayed as the text of the apply button
Parameters
| applyLabel | the apply label |
|---|
public abstract void setApplyTooltip (String applyTooltip)
set the apply tooltip, which is displayed as the text of the apply button
Parameters
| applyTooltip | the apply tooltip |
|---|
public abstract void setAttribute (String attributeName, String value, int location)
Set attributes on the location specified (EnumEditorSectionTypes.EditorMainDiv, EnumEditorSectionTypes.EditorTitleDiv, EnumEditorSectionTypes.EditorBodyDiv). We use it for setting the bone properties.
Parameters
| attributeName | the name of the attribute to be set |
|---|---|
| value | the value to be set for the named attribute |
| location | the location to add the attribute as EnumEditorSectionTypes |
public abstract void setButtonDisabled (int button, boolean disableValue)
Set the disabled property of the specified button.
The button which needs to be disabled is one of APPLY_BUTTON, OK_BUTTON or CANCEL_BUTTON
Parameters
| button | The actual button whose disabled property needs to be changed. |
|---|---|
| disableValue | boolean value set to true to disable the apply button. |
public abstract void setButtonsCss (String css)
set the button css class name for the editor
Parameters
| css | the css class name |
|---|
public abstract void setCanAutoSize (boolean value)
Set to true if the editor can auto size to show its contents
Parameters
| value | The boolean value set to true if if the editor can auto size to show its contents |
|---|
public abstract void setCancelEvent (WebEvent event)
set the cancel event for the editor
Parameters
| event | the cancel event |
|---|
public abstract void setCancelJS (String value)
Specifies JavaScript function to be invoked when canceling Editor in DHTML mode only.
Parameters
| value | String Array consisted of function name and parameters. |
|---|
public abstract void setCancelLabel (String cancelLabel)
set the cancel label, which is displayed as the text of the cancel button
Parameters
| cancelLabel | the cancel label |
|---|
public abstract void setCancelTooltip (String cancelLabel)
set the cancel tooltip, which is displayed as the text of the cancel button
Parameters
| cancelLabel | the cancel label |
|---|
public abstract void setCloseEvent (WebEvent event)
set the close event for the editor
Parameters
| event | the close event |
|---|
public abstract void setCloseJS (String value)
Specifies JavaScript function to be invoked when closing Editor in DHTML mode only.
Parameters
| value | String Array consisted of function name and parameters. |
|---|
public abstract void setCloseLabel (String closeLabel)
set the close label, which is displayed as the tooltip of the close icon
Parameters
| closeLabel | the close label |
|---|
public abstract void setContents (MarkupOutput out)
This method is deprecated.
Don't create a MarkupOutput and create it, instead call getContents
and populate this instance.
Registers the content of the editor. This is the body section. Users can provide their own populated MarkupOutput which will be appended to the editor's output in the body section.
Is not recommeneded to use this method (in fact, it has been deprecated). Users should instead call thegetContents method which returns a MarkupOutput
and populate this object.Parameters
| out | the content as a MarkupOutput object |
|---|
public abstract void setContentsCss (String css)
set the content css class name for the editor
Parameters
| css | the css class name |
|---|
public abstract void setCssPrefix (String value)
Set the cssPrefix for the editor container
Parameters
| value | The String that is to be used for the cssPrefix for the editor container |
|---|
public abstract void setDisplayFlags (int flags)
set the display flag for the editor
Parameters
| flags | the display flag |
|---|
public abstract void setEditorDefinitionLayout (String fileName)
Sets the definition layout for the editor. The definition layout indicates what section of the editor to display i.e. the buttons to include in the footer.
Parameters
| fileName | the definition of the editor |
|---|
public abstract void setExtraProperties (MarkupOutput mo)
This method is deprecated.
replaced by setAttribute(String, String, int)
Set extra information to the whole editor. We use it for setting the drag and drop properties.
Parameters
| mo | the MarkupOutput object |
|---|
public abstract void setForm (String action, String method, String formName, String extraAttributes, String onSubmitInfo)
set the form information for the editor
Parameters
| action | the action attribute of the form |
|---|---|
| method | the method attribute of the form |
| formName | the name attribute of the form |
| extraAttributes | extra attributes in the form definition |
| onSubmitInfo | the onSubmit attribute of the form |
public abstract void setForm (String action, String method, String formName, String extraAttributes)
set the form information for the editor
Parameters
| action | the action attribute of the form |
|---|---|
| method | the method attribute of the form |
| formName | the name attribute of the form |
| extraAttributes | extra attributes in the form definition |
public abstract void setForm (String action, String method, String formName)
set the form information for the editor
Parameters
| action | the action attribute of the form |
|---|---|
| method | the method attribute of the form |
| formName | the name attribute of the form |
public abstract void setFormId (String value)
Set the if of the form to use in XHR partial update
Parameters
| value | String the value+"_form" forms the actual id of the form that should be submitted |
|---|
public abstract void setGlobalContentCss (String css)
set the global content css class name for the editor
Parameters
| css | the css class name |
|---|
public abstract void setGlobalCss (String css)
set the global css class name for the editor
Parameters
| css | the css class name |
|---|
public abstract void setHelpEvent (WebEvent event)
This method is deprecated.
use setHelpType(String)
set the help event for the editor
Parameters
| event | the help event |
|---|
public abstract void setHelpLabel (String helpLabel)
set the help label, which is displayed as the tooltip of the help icon
Parameters
| helpLabel | the help label |
|---|
public abstract void setHelpToolTip (String title)
set the tooltip of the editor
Parameters
| title | the tooltip of the editor |
|---|
public abstract void setHelpTopic (String topic)
set the help topic of the editor
Parameters
| topic | the help topic |
|---|
public abstract void setHelpType (String type)
set the help type for the editor
Parameters
| type | String is one of HELP_TYPE_ADMIN,HELP_TYPE_USER,HELP_TYPE_CUSTOM |
|---|
public abstract void setHideFocus (boolean value)
set the hide focus property of the buttons in the editor
Parameters
| value | the value of the hide focus property |
|---|
public abstract void setImageBasePath (String path)
Set the folder path to be used as base for all the images to use while displaying menus
Parameters
| path | the folder path |
|---|
public abstract void setOKLabel (String OKLabel)
set the ok label, which is displayed as the text of the ok button
Parameters
| OKLabel | the ok label |
|---|
public abstract void setOKTooltip (String OKLabel)
set the ok tooltip, which is displayed as the text of the ok button
Parameters
| OKLabel | the ok label |
|---|
public abstract void setOkEvent (WebEvent event)
set the ok event for the editor
Parameters
| event | the ook event |
|---|
public abstract void setOkJS (String value)
Specifies JavaScript function to be invoked when pressing Editor's 'OK' button in DHTML mode only.
Parameters
| value | String Array consisted of function name and parameters. |
|---|
public abstract void setPostButtonContents (MarkupOutput out)
set the content after the apply/ok/cancel buttons
Parameters
| out | the content as a MarkupOutput object
|
|---|
public abstract void setSpaceAfterEditor (boolean spaceAfterEditor)
Set whethere display a blank space underneath the editor
Parameters
| spaceAfterEditor | whethere display a blank space underneath the editor |
|---|
public abstract void setTitle (String title)
set the title of the editor
Parameters
| title | the title of the editor |
|---|
public abstract void setTitleCss (String css)
set the title css class name for the editor
Parameters
| css | the css class name |
|---|
public abstract void setTitleElements (MarkupOutput out)
set the title elements of the editor
Parameters
| out | the title elements as a MarkupOutput object
|
|---|
public abstract void setTitleElementsCss (String css)
set the title elements' css class name for the editor
Parameters
| css | the css class name |
|---|
public abstract void setUseDHTMLForEditorClose (boolean value)
Set to true if we want to use DHTML code to close the editor
Parameters
| value | The boolean value set to true if we want to use DHTML code to close the editor |
|---|