public class

ObjectManipulationDialogTransform

extends RestrictedFolderObjectExplorerTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
             ↳ com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
               ↳ com.microstrategy.web.app.transforms.FolderObjectExplorerTransform
                 ↳ com.microstrategy.web.app.transforms.RestrictedFolderObjectExplorerTransform
                   ↳ com.microstrategy.web.app.transforms.ObjectManipulationDialogTransform

Class Overview

Title: ObjectManipulationDialogTransform.

Description: Transform class for parsing ObjectManipulationDialogBean and generating its output.

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

Summary

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
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter displayIconOption Indicates whether to display the icon option on the dialog
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
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 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
From class com.microstrategy.web.app.transforms.RestrictedFolderObjectExplorerTransform
From class com.microstrategy.web.app.transforms.FolderObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_DISPLAY_ICON_OPTION

Constant specifying the name of the formal parameter for displaying the icon option on the dialog

Constant Value: "displayIconOption"

Fields

public FormalParameter displayIconOption

Indicates whether to display the icon option on the dialog

Public Constructors

public ObjectManipulationDialogTransform ()

Default no-args constructor, initialize formal parameters.

Public Methods

public String getDescription ()

Returns the textual description of current transform class.

Returns
  • String the description of the transform.

public String getEditorTitle ()

Throws
IllegalArgumentException

public String getObjectTypeName ()

Returns a localized string which returns the type of the object on which the Object Manipulation Dialog was open.

Returns

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports ObjectManipulationDialogBean instances

Returns
  • ObjectManipulationDialogBean instance.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.

Parameters
data bean that will be transformed

public boolean isCurrentObjectUnAvailable ()

public boolean isEmptyList ()

Returns true if the list of elements from this folder available for display (getContents()) is empty or not.

public boolean isLinkInformationAvailable ()

public 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.

Parameters
out MarkupOutput instance with the output by this transform

public void renderCopyMoveAction (MarkupOutput out)

public 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. 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.

Parameters
out MarkupOutput

public void renderCopyMoveHeader (MarkupOutput out)

Renders the header for the Copy/Move dialogs.

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderCopyMovePath (MarkupOutput out)

Renders the path of the object to be copied/moved for the Copy/Move dialogs.

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderCopyMoveToFolderText (MarkupOutput out)

Renders the localized string "To the folder:" above the object browser for the Copy/Move dialogs.

public void renderCopyNameTranslationsProperty (MarkupOutput out)

Renders the copy name translations section on the dialog.

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderCreateFolderButton (MarkupOutput out)

Renders the button that opens the create folder dialog

Parameters
out MarkupOutput

public void renderCreatedField (MarkupOutput out)

Renders the value for the property which provides the time/date when the object was created.

Parameters
out MarkupOutput

public void renderCreatedLabel (MarkupOutput out)

Renders a label for the property which provides information on when the object was created.

Parameters
out MarkupOutput

public void renderCreatedProperty (MarkupOutput out)

Renders the property of the object which provides information on when the object was created.

Parameters
out MarkupOutput

public void renderDescriptionField (MarkupOutput out)

Renders the text input for the formula name section

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderDescriptionLabel (MarkupOutput out)

Renders the title label that appears before the formula name section

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderDescriptionProperty (MarkupOutput out)

Renders the formala name section on the dialog.

public void renderEditorContents (MarkupOutput out)

Generates the graphical output for the Projects Bean

Parameters
out MarkupOutput instance where to create the HTML output.

public 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.

Parameters
out MarkupOutput

public void renderErrorMessage (MarkupOutput out)

The method renders an error message if an error has occurred.

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderExportLinkBody (MarkupOutput out)

Renders the contents of the Export link for an object. This is a readonly dialog which contains information about the link.

Parameters
out MarkupOutput

public void renderGuidField (MarkupOutput out)

Renders the value for the unique GUID property of the object on the properties dialog.

Parameters
out MarkupOutput

public void renderGuidLabel (MarkupOutput out)

Renders the label for the unique GUID property of the object on the properties dialog.

Parameters
out MarkupOutput

public void renderGuidProperty (MarkupOutput out)

Renders the unique GUID property of the object on the properties dialog.

Parameters
out MarkupOutput

public void renderIconField (MarkupOutput out)

Renders the text input for the icon section

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderIconLabel (MarkupOutput out)

Renders the title label that appears before the icon section

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderLinkField (MarkupOutput out)

Renders the value for the property which stores a link to the location of the object.

Parameters
out MarkupOutput

public void renderLinkFieldForExport (MarkupOutput out)

Renders the link to the location of the object into the text box.

Parameters
out MarkupOutput

public void renderLinkLabel (MarkupOutput out)

Renders the label for the property which stores a link to the object's location on the meta-data.

public void renderLinkProperty (MarkupOutput out)

Renders the property which stores a link to the object's location on the meta-data.

Parameters
out MarkupOutput

public void renderLocationField (MarkupOutput out)

Renders the value for the location property on the properties dialog.

Parameters
out MarkupOutput

public void renderLocationLabel (MarkupOutput out)

Renders the label for the location property on the properties dialog.

Parameters
out MarkupOutput

public void renderLocationProperty (MarkupOutput out)

Renders the location of a given object on the meta-data on the properties dialog.

Parameters
out MarkupOutput

public void renderModifiedField (MarkupOutput out)

Renders the date/time of when the object was last modified based on the object's property.

public void renderModifiedLabel (MarkupOutput out)

Renders the label for the property which tells us when the property was last modified.

Parameters
out MarkupOutput

public void renderModifiedProperty (MarkupOutput out)

Renders the property which gives information on when the object was last modified.

Parameters
out MarkupOutput

public void renderNameField (MarkupOutput out)

Renders a textbox in the Rename dialog which allows the user to change the name of the object.

Parameters
out MarkupOutput

public void renderNameLabel (MarkupOutput out)

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.

Parameters
out MarkupOutput

public void renderNameProperty (MarkupOutput out)

Renders the rename dialog. It consists of a textbox which allows the user to rename the object's name

Parameters
out MarkupOutput

public void renderOwnerField (MarkupOutput out)

Renders the value of the owner property of the object.

Parameters
out MarkupOutput

public void renderOwnerLabel (MarkupOutput out)

Renders a label to the Owner property of the object.

Parameters
out MarkupOutput

public void renderOwnerProperty (MarkupOutput out)

Renders the property which stores the owner information for an object.

Parameters
out MarkupOutput

public 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.

Parameters
out MarkupOutput

public void renderPropertiesBody (MarkupOutput out)

Renders the contents of the Properties Dialog for an object. This is a readonly dialog which contains information about the object.

Parameters
out MarkupOutput

public void renderRenameBody (MarkupOutput out)

Renders the rename dialog. It consists of a textbox which allows the user to rename the object's name

Parameters
out MarkupOutput

public void renderShowTargetButton (MarkupOutput out)

Renders a button which allows the user to view the properties of a shortcut object's target.

Parameters
out MarkupOutput

public void renderTypeField (MarkupOutput out)

Renders the value for the type information of an object on the properties dialog.

Parameters
out MarkupOutput

public void renderTypeLabel (MarkupOutput out)

Renders the label for the type information of the object on the properties dialog.

Parameters
out MarkupOutput

public void renderTypeProperty (MarkupOutput out)

Renders the type information for an object.

Parameters
out MarkupOutput

Protected Methods

protected AnchorTag generateAnchorForLinkProperty (WebEvent event)

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.

Parameters
event WebEvent
Returns
  • AnchorTag

protected WebEvent getApplyEvent ()

Returns an instance of the event responsible for processing the editor's actions

Returns
  • a WebEvent instance with the information needed for submitting an apply request.

protected WebEvent getExecuteEvent (WebObjectInfo object)

protected String getOnSubmitJS ()

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

Returns
  • JS code to be executed on the "onsubmit" event of the HTML form.

protected boolean hasOtherNameTranslations ()

Determine if the target object has other name translations or not

Returns
  • boolean value indicating if the target object has other name translations or not

protected void initEditor (Editor editor)

Initialize the editor with the global settings.

Parameters
editor Editor instance, abstraction of the container where output is rendered.

protected void initHelp (Editor editor)

Initialize help type and topic for specific dialog.

Parameters
editor Editor instance, abstraction of the container where output is rendered.