Package com.microstrategy.web.app.transforms

Class ObjectManipulationDialogTransform

  • All Implemented Interfaces:
    AppTransform, LayoutTransform, Transform
    public class ObjectManipulationDialogTransform
extends RestrictedFolderObjectExplorerTransform

    Title: ObjectManipulationDialogTransform.

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

    Copyright: Copyright (c) 2002

    Company: Microstrategy, Inc.

    Since:
    MicroStrategy Web 8.0.0

    • Field Detail

      • FP_DISPLAY_ICON_OPTION

        public static final java.lang.String FP_DISPLAY_ICON_OPTION
        Constant specifying the name of the formal parameter for displaying the icon option on the dialog
        See Also:
        Constant Field Values

      • displayIconOption

        public FormalParameter displayIconOption
        Indicates whether to display the icon option on the dialog

    • Constructor Detail

      • ObjectManipulationDialogTransform

        public ObjectManipulationDialogTransform()
        Default no-args constructor, initialize formal parameters.

    • Method Detail

      • initEditor

        protected void initEditor​(Editor editor)
        Initialize the editor with the global settings.
        Overrides:
        initEditor in class AbstractEditorTransform
        Parameters:
        editor - Editor instance, abstraction of the container where output is rendered.

      • initHelp

        protected void initHelp​(Editor editor)
        Initialize help type and topic for specific dialog.
        Overrides:
        initHelp in class AbstractEditorTransform
        Parameters:
        editor - Editor instance, abstraction of the container where output is rendered.
        Since:
        MicroStrategy Web 9.0.0

      • renderCopyMoveBody

        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

      • renderAdvancedOptions

        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

      • renderCopyNameTranslationsProperty

        public void renderCopyNameTranslationsProperty​(MarkupOutput out)
        Renders the copy name translations section on the dialog.
        Parameters:
        out - MarkupOutput instance where to create the HTML output.

      • hasOtherNameTranslations

        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

      • renderErrorBody

        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

      • renderRenameBody

        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

      • renderPropertiesBody

        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

      • renderExportLinkBody

        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

      • renderNameProperty

        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

      • renderNameLabel

        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

      • renderNameField

        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

      • renderDescriptionProperty

        public void renderDescriptionProperty​(MarkupOutput out)
        Renders the formala name section on the dialog.
        Parameters:
        out -

      • renderDescriptionLabel

        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.

      • renderIconLabel

        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.

      • renderDescriptionField

        public void renderDescriptionField​(MarkupOutput out)
        Renders the text input for the formula name section
        Parameters:
        out - MarkupOutput instance where to create the HTML output.

      • renderIconField

        public void renderIconField​(MarkupOutput out)
        Renders the text input for the icon section
        Parameters:
        out - MarkupOutput instance where to create the HTML output.

      • renderShowTargetButton

        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

      • renderTypeProperty

        public void renderTypeProperty​(MarkupOutput out)
        Renders the type information for an object.
        Parameters:
        out - MarkupOutput

      • renderTypeLabel

        public void renderTypeLabel​(MarkupOutput out)
        Renders the label for the type information of the object on the properties dialog.
        Parameters:
        out - MarkupOutput

      • renderTypeField

        public void renderTypeField​(MarkupOutput out)
        Renders the value for the type information of an object on the properties dialog.
        Parameters:
        out - MarkupOutput

      • renderLocationProperty

        public void renderLocationProperty​(MarkupOutput out)
        Renders the location of a given object on the meta-data on the properties dialog.
        Parameters:
        out - MarkupOutput

      • renderLocationLabel

        public void renderLocationLabel​(MarkupOutput out)
        Renders the label for the location property on the properties dialog.
        Parameters:
        out - MarkupOutput

      • renderLocationField

        public void renderLocationField​(MarkupOutput out)
        Renders the value for the location property on the properties dialog.
        Parameters:
        out - MarkupOutput

      • renderGuidProperty

        public void renderGuidProperty​(MarkupOutput out)
        Renders the unique GUID property of the object on the properties dialog.
        Parameters:
        out - MarkupOutput

      • renderGuidLabel

        public void renderGuidLabel​(MarkupOutput out)
        Renders the label for the unique GUID property of the object on the properties dialog.
        Parameters:
        out - MarkupOutput

      • renderGuidField

        public void renderGuidField​(MarkupOutput out)
        Renders the value for the unique GUID property of the object on the properties dialog.
        Parameters:
        out - MarkupOutput

      • renderOwnerProperty

        public void renderOwnerProperty​(MarkupOutput out)
        Renders the property which stores the owner information for an object.
        Parameters:
        out - MarkupOutput

      • renderLinkProperty

        public void renderLinkProperty​(MarkupOutput out)
        Renders the property which stores a link to the object's location on the meta-data.
        Parameters:
        out - MarkupOutput

      • renderLinkLabel

        public void renderLinkLabel​(MarkupOutput out)
        Renders the label for the property which stores a link to the object's location on the meta-data.
        Parameters:
        out -

      • isLinkInformationAvailable

        public boolean isLinkInformationAvailable()

      • isEmptyList

        public boolean isEmptyList()
        Returns true if the list of elements from this folder available for display (ObjectExplorerBean.getContents()) is empty or not.
        Since:
        MicroStrategy Web 9.0.0

      • isCurrentObjectUnAvailable

        public boolean isCurrentObjectUnAvailable()

      • generateAnchorForLinkProperty

        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
        Since:
        MicroStrategy Web 9.0.0

      • renderLinkField

        public void renderLinkField​(MarkupOutput out)
        Renders the value for the property which stores a link to the location of the object.
        Parameters:
        out - MarkupOutput

      • renderLinkFieldForExport

        public void renderLinkFieldForExport​(MarkupOutput out)
        Renders the link to the location of the object into the text box.
        Parameters:
        out - MarkupOutput

      • renderOwnerLabel

        public void renderOwnerLabel​(MarkupOutput out)
        Renders a label to the Owner property of the object.
        Parameters:
        out - MarkupOutput

      • renderOwnerField

        public void renderOwnerField​(MarkupOutput out)
        Renders the value of the owner property of the object.
        Parameters:
        out - MarkupOutput

      • renderCreatedProperty

        public void renderCreatedProperty​(MarkupOutput out)
        Renders the property of the object which provides information on when the object was created.
        Parameters:
        out - MarkupOutput

      • renderCreatedLabel

        public void renderCreatedLabel​(MarkupOutput out)
        Renders a label for the property which provides information on when the object was created.
        Parameters:
        out - MarkupOutput

      • renderCreatedField

        public void renderCreatedField​(MarkupOutput out)
        Renders the value for the property which provides the time/date when the object was created.
        Parameters:
        out - MarkupOutput

      • renderModifiedProperty

        public void renderModifiedProperty​(MarkupOutput out)
        Renders the property which gives information on when the object was last modified.
        Parameters:
        out - MarkupOutput

      • renderModifiedLabel

        public void renderModifiedLabel​(MarkupOutput out)
        Renders the label for the property which tells us when the property was last modified.
        Parameters:
        out - MarkupOutput

      • renderModifiedField

        public void renderModifiedField​(MarkupOutput out)
        Renders the date/time of when the object was last modified based on the object's property.
        Parameters:
        out -

      • renderProjectBrowser

        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

      • renderCertifiedLabel

        public void renderCertifiedLabel​(MarkupOutput out)
        Renders a label for the property which provides information on if the object is certified
        Parameters:
        out - MarkupOutput

      • renderCertifiedField

        public void renderCertifiedField​(MarkupOutput out)
        Renders a checkbox for the property which provides information on if the object is certified
        Parameters:
        out - MarkupOutput

      • getEditorTitle

        public java.lang.String getEditorTitle()
                                throws java.lang.IllegalArgumentException
        Overrides:
        getEditorTitle in class AbstractEditorTransform
        Throws:
        java.lang.IllegalArgumentException

      • getObjectTypeName

        public java.lang.String getObjectTypeName()
        Returns a localized string which returns the type of the object on which the Object Manipulation Dialog was open.
        Returns:
        MarkupOutput

      • renderCopyMoveHeader

        public void renderCopyMoveHeader​(MarkupOutput out)
        Renders the header for the Copy/Move dialogs.
        Parameters:
        out - MarkupOutput instance where to create the HTML output.

      • renderCopyMoveAction

        public void renderCopyMoveAction​(MarkupOutput out)

      • renderCopyMovePath

        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.

      • renderCopyMoveToFolderText

        public void renderCopyMoveToFolderText​(MarkupOutput out)
        Renders the localized string "To the folder:" above the object browser for the Copy/Move dialogs.
        Parameters:
        out -

      • renderCreateFolderButton

        public void renderCreateFolderButton​(MarkupOutput out)
        Renders the button that opens the create folder dialog
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 9.0.0

      • getApplyEvent

        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.

      • getOnSubmitJS

        protected java.lang.String getOnSubmitJS()
        Description copied from class: AbstractEditorTransform
        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
        Overrides:
        getOnSubmitJS in class AbstractEditorTransform
        Returns:
        JS code to be executed on the "onsubmit" event of the HTML form.