Title: ObjectManipulationDialogTransform.
Description: Transform class for parsing ObjectManipulationDialogBean and generating its output.
Copyright: Copyright (c) 2002
Company: Microstrategy, Inc.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | FP_DISPLAY_ICON_OPTION | Constant specifying the name of the formal parameter for displaying the icon option on the dialog |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
public FormalParameter | displayIconOption | Indicates whether to display the icon option on the dialog |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
ObjectManipulationDialogTransform()
Default no-args constructor, initialize formal parameters.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String |
getDescription()
Returns the textual description of current transform class.
| ||||||||||
String | getEditorTitle() | ||||||||||
String |
getObjectTypeName()
Returns a localized string which returns the type of the object on which the Object Manipulation Dialog was open.
| ||||||||||
Class |
getSupportedBeanType()
Returns the supported bean type.
| ||||||||||
void |
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
| ||||||||||
boolean | isCurrentObjectUnAvailable() | ||||||||||
boolean |
isEmptyList()
Returns
true if the list of elements from this folder available for display
(getContents() ) is empty or not. | ||||||||||
boolean | isLinkInformationAvailable() | ||||||||||
void |
renderAdvancedOptions(MarkupOutput out)
Generates the dialog for allowing the user to define advanced copy options
calls
renderCopyNameTranslationsProperty , renderLinkOptions
and renderAdvancedCreateButtonBar for displaying the fields available to the user. | ||||||||||
void |
renderCertifiedField(MarkupOutput out)
Renders a checkbox for the property which provides information on if the object is certified
| ||||||||||
void |
renderCertifiedLabel(MarkupOutput out)
Renders a label for the property which provides information on if the object is certified
| ||||||||||
void | renderCopyMoveAction(MarkupOutput out) | ||||||||||
void |
renderCopyMoveBody(MarkupOutput out)
This method renders the body of the Object Manipulation dialog when it opens for either a Copy or a
Move process.
| ||||||||||
void |
renderCopyMoveHeader(MarkupOutput out)
Renders the header for the Copy/Move dialogs.
| ||||||||||
void |
renderCopyMovePath(MarkupOutput out)
Renders the path of the object to be copied/moved for the Copy/Move dialogs.
| ||||||||||
void |
renderCopyMoveToFolderText(MarkupOutput out)
Renders the localized string "To the folder:" above the object browser for the
Copy/Move dialogs.
| ||||||||||
void |
renderCopyNameTranslationsProperty(MarkupOutput out)
Renders the copy name translations section on the dialog.
| ||||||||||
void |
renderCreateFolderButton(MarkupOutput out)
Renders the button that opens the create folder dialog
| ||||||||||
void |
renderCreatedField(MarkupOutput out)
Renders the value for the property which provides the time/date when the object was created.
| ||||||||||
void |
renderCreatedLabel(MarkupOutput out)
Renders a label for the property which provides information on when the object was created.
| ||||||||||
void |
renderCreatedProperty(MarkupOutput out)
Renders the property of the object which provides information on when the object was created.
| ||||||||||
void |
renderDescriptionField(MarkupOutput out)
Renders the text input for the formula name section
| ||||||||||
void |
renderDescriptionLabel(MarkupOutput out)
Renders the title label that appears before the formula name section
| ||||||||||
void |
renderDescriptionProperty(MarkupOutput out)
Renders the formala name section on the dialog.
| ||||||||||
void |
renderEditorContents(MarkupOutput out)
Generates the graphical output for the Projects Bean
| ||||||||||
void |
renderErrorBody(MarkupOutput out)
In the case of a error on the Object Manipulation Dialog, this method renders the
error message as a part of the dialog's body.
| ||||||||||
void |
renderErrorMessage(MarkupOutput out)
The method renders an error message if an error has occurred.
| ||||||||||
void |
renderExportLinkBody(MarkupOutput out)
Renders the contents of the Export link for an object.
| ||||||||||
void |
renderGuidField(MarkupOutput out)
Renders the value for the unique GUID property of the object on the properties dialog.
| ||||||||||
void |
renderGuidLabel(MarkupOutput out)
Renders the label for the unique GUID property of the object on the properties dialog.
| ||||||||||
void |
renderGuidProperty(MarkupOutput out)
Renders the unique GUID property of the object on the properties dialog.
| ||||||||||
void |
renderIconField(MarkupOutput out)
Renders the text input for the icon section
| ||||||||||
void |
renderIconLabel(MarkupOutput out)
Renders the title label that appears before the icon section
| ||||||||||
void |
renderLinkField(MarkupOutput out)
Renders the value for the property which stores a link to the location of the object.
| ||||||||||
void |
renderLinkFieldForExport(MarkupOutput out)
Renders the link to the location of the object into the text box.
| ||||||||||
void |
renderLinkLabel(MarkupOutput out)
Renders the label for the property which stores a link to the object's location on the meta-data.
| ||||||||||
void |
renderLinkProperty(MarkupOutput out)
Renders the property which stores a link to the object's location on the meta-data.
| ||||||||||
void |
renderLocationField(MarkupOutput out)
Renders the value for the location property on the properties dialog.
| ||||||||||
void |
renderLocationLabel(MarkupOutput out)
Renders the label for the location property on the properties dialog.
| ||||||||||
void |
renderLocationProperty(MarkupOutput out)
Renders the location of a given object on the meta-data on the properties dialog.
| ||||||||||
void |
renderModifiedField(MarkupOutput out)
Renders the date/time of when the object was last modified based on the object's property.
| ||||||||||
void |
renderModifiedLabel(MarkupOutput out)
Renders the label for the property which tells us when the property was last modified.
| ||||||||||
void |
renderModifiedProperty(MarkupOutput out)
Renders the property which gives information on when the object was last modified.
| ||||||||||
void |
renderNameField(MarkupOutput out)
Renders a textbox in the Rename dialog which allows the user to change the name of the object.
| ||||||||||
void |
renderNameLabel(MarkupOutput out)
Renders a label for the Rename Dialog and attaches the Rename event to it.
| ||||||||||
void |
renderNameProperty(MarkupOutput out)
Renders the rename dialog.
| ||||||||||
void |
renderOwnerField(MarkupOutput out)
Renders the value of the owner property of the object.
| ||||||||||
void |
renderOwnerLabel(MarkupOutput out)
Renders a label to the Owner property of the object.
| ||||||||||
void |
renderOwnerProperty(MarkupOutput out)
Renders the property which stores the owner information for an object.
| ||||||||||
void |
renderProjectBrowser(MarkupOutput out)
In case of dialogs which need to browse through the different objects of the object, this
creates a project browser within the dialog.
| ||||||||||
void |
renderPropertiesBody(MarkupOutput out)
Renders the contents of the Properties Dialog for an object.
| ||||||||||
void |
renderRenameBody(MarkupOutput out)
Renders the rename dialog.
| ||||||||||
void |
renderShowTargetButton(MarkupOutput out)
Renders a button which allows the user to view the properties of a shortcut object's target.
| ||||||||||
void |
renderTypeField(MarkupOutput out)
Renders the value for the type information of an object on the properties dialog.
| ||||||||||
void |
renderTypeLabel(MarkupOutput out)
Renders the label for the type information of the object on the properties dialog.
| ||||||||||
void |
renderTypeProperty(MarkupOutput out)
Renders the type information for an object.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
AnchorTag |
generateAnchorForLinkProperty(WebEvent event)
Overwrites the parent method by adding the Server, Project and Port information to
the links generated.
| ||||||||||
WebEvent |
getApplyEvent()
Returns an instance of the event responsible for processing the editor's actions
| ||||||||||
WebEvent | getExecuteEvent(WebObjectInfo object) | ||||||||||
String |
getOnSubmitJS()
Provides JS code to be executed on the "onsubmit" event of the HTML form.
| ||||||||||
boolean |
hasOtherNameTranslations()
Determine if the target object has other name translations or not
| ||||||||||
void |
initEditor(Editor editor)
Initialize the editor with the global settings.
| ||||||||||
void |
initHelp(Editor editor)
Initialize help type and topic for specific dialog.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Constant specifying the name of the formal parameter for displaying the icon option on the dialog
Default no-args constructor, initialize formal parameters.
Returns the textual description of current transform class.
IllegalArgumentException |
---|
Returns a localized string which returns the type of the object on which the Object Manipulation Dialog was open.
Returns the supported bean type. This transform supports ObjectManipulationDialogBean
instances
ObjectManipulationDialogBean
instance.
This method initialize the private and protected fields of the transform.
data | bean that will be transformed |
---|
Returns true
if the list of elements from this folder available for display
(getContents()
) is empty or not.
Generates the dialog for allowing the user to define advanced copy options
calls renderCopyNameTranslationsProperty
, renderLinkOptions
and renderAdvancedCreateButtonBar
for displaying the fields available to the user.
out | MarkupOutput instance with the output by this transform
|
---|
Renders a checkbox for the property which provides information on if the object is certified
out | MarkupOutput
|
---|
Renders a label for the property which provides information on if the object is certified
out | MarkupOutput
|
---|
This method renders the body of the Object Manipulation dialog when it opens for either a Copy or a Move process. It contains information about the file, where it's located, and a browser to select the location of where you want to copy or move the object.
out | MarkupOutput
|
---|
Renders the header for the Copy/Move dialogs.
out | MarkupOutput instance where to create the HTML output.
|
---|
Renders the path of the object to be copied/moved for the Copy/Move dialogs.
out | MarkupOutput instance where to create the HTML output.
|
---|
Renders the localized string "To the folder:" above the object browser for the Copy/Move dialogs.
Renders the copy name translations section on the dialog.
out | MarkupOutput instance where to create the HTML output.
|
---|
Renders the button that opens the create folder dialog
out | MarkupOutput |
---|
Renders the value for the property which provides the time/date when the object was created.
out | MarkupOutput
|
---|
Renders a label for the property which provides information on when the object was created.
out | MarkupOutput
|
---|
Renders the property of the object which provides information on when the object was created.
out | MarkupOutput
|
---|
Renders the text input for the formula name section
out | MarkupOutput instance where to create the HTML output.
|
---|
Renders the title label that appears before the formula name section
out | MarkupOutput instance where to create the HTML output.
|
---|
Renders the formala name section on the dialog.
Generates the graphical output for the Projects Bean
out | MarkupOutput instance where to create the HTML output.
|
---|
In the case of a error on the Object Manipulation Dialog, this method renders the error message as a part of the dialog's body.
out | MarkupOutput
|
---|
The method renders an error message if an error has occurred.
out | MarkupOutput instance where to create the HTML output.
|
---|
Renders the contents of the Export link for an object. This is a readonly dialog which contains information about the link.
out | MarkupOutput
|
---|
Renders the value for the unique GUID property of the object on the properties dialog.
out | MarkupOutput
|
---|
Renders the label for the unique GUID property of the object on the properties dialog.
out | MarkupOutput
|
---|
Renders the unique GUID property of the object on the properties dialog.
out | MarkupOutput
|
---|
Renders the text input for the icon section
out | MarkupOutput instance where to create the HTML output.
|
---|
Renders the title label that appears before the icon section
out | MarkupOutput instance where to create the HTML output.
|
---|
Renders the value for the property which stores a link to the location of the object.
out | MarkupOutput
|
---|
Renders the link to the location of the object into the text box.
out | MarkupOutput
|
---|
Renders the label for the property which stores a link to the object's location on the meta-data.
Renders the property which stores a link to the object's location on the meta-data.
out | MarkupOutput
|
---|
Renders the value for the location property on the properties dialog.
out | MarkupOutput
|
---|
Renders the label for the location property on the properties dialog.
out | MarkupOutput
|
---|
Renders the location of a given object on the meta-data on the properties dialog.
out | MarkupOutput
|
---|
Renders the date/time of when the object was last modified based on the object's property.
Renders the label for the property which tells us when the property was last modified.
out | MarkupOutput
|
---|
Renders the property which gives information on when the object was last modified.
out | MarkupOutput
|
---|
Renders a textbox in the Rename dialog which allows the user to change the name of the object.
out | MarkupOutput
|
---|
Renders a label for the Rename Dialog and attaches the Rename event to it. It also checks whether the object's name is update-able based on privileges and properties.
out | MarkupOutput
|
---|
Renders the rename dialog. It consists of a textbox which allows the user to rename the object's name
out | MarkupOutput
|
---|
Renders the value of the owner property of the object.
out | MarkupOutput
|
---|
Renders a label to the Owner property of the object.
out | MarkupOutput
|
---|
Renders the property which stores the owner information for an object.
out | MarkupOutput
|
---|
In case of dialogs which need to browse through the different objects of the object, this creates a project browser within the dialog.
out | MarkupOutput
|
---|
Renders the contents of the Properties Dialog for an object. This is a readonly dialog which contains information about the object.
out | MarkupOutput
|
---|
Renders the rename dialog. It consists of a textbox which allows the user to rename the object's name
out | MarkupOutput
|
---|
Renders a button which allows the user to view the properties of a shortcut object's target.
out | MarkupOutput
|
---|
Renders the value for the type information of an object on the properties dialog.
out | MarkupOutput
|
---|
Renders the label for the type information of the object on the properties dialog.
out | MarkupOutput
|
---|
Renders the type information for an object.
out | MarkupOutput
|
---|
Overwrites the parent method by adding the Server, Project and Port information to the links generated. Also, it defines by default an onclick attribute for closing the editor where this link is displayed.
event | WebEvent |
---|
Returns an instance of the event responsible for processing the editor's actions
WebEvent
instance with the information needed for submitting an apply
request.
Provides JS code to be executed on the "onsubmit" event of the HTML form.
Used for customizations where an action is needed before the form is submitted.
Note: this is only used when the editor uses an event and not JS on the OK/Apply buttons.
For those cases use the "okJS" or "applyJS" formal parameters
Determine if the target object has other name translations or not
Initialize the editor with the global settings.
editor | Editor instance, abstraction of the container where output is rendered. |
---|
Initialize help type and topic for specific dialog.
editor | Editor instance, abstraction of the container where output is rendered. |
---|