public class

DragAndDropItem

extends Object
implements EnumDragAndDropProperties
java.lang.Object
   ↳ com.microstrategy.web.app.gui.DragAndDropItem

Class Overview

Title: MSTR Web Gui Element: Drag And Drop Item Description: Represents the drag-and-drop enabled HTML piece for a zone (DIV, TD, or SPAN) Copyright: Copyright (c) 2002 Company: MicroStrategy

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.gui.EnumDragAndDropProperties
Public Constructors
DragAndDropItem()
no-arg constructor
Public Methods
void addAttributes(Map atts)
Appends the attribute information required for the drag and drop functionality to be linked to an element on the HTML interface
void addGridCellInitInfo(Map atts)
void generateOutput(MarkupOutput mo)
generate the output for a drag item or a drop item
MarkupOutput generateOutput()
generate the output for a drag item or a drop item
String getAttFormId()
Returns the attribute form ID for the draggable object
String getAttFormList()
Returns the attribute form list for the draggable object
String getAttFormName()
Returns the attribute form Name for the draggable object
int getAttFormPosition()
Returns the form position within the attribute
Map getAttributes()
Generate the attribute information required for the drag and drop functionality to be linked to an element on the HTML interface
int getAxisID()
Returns the axis id of the item (either object or target)
boolean getCanAddThresholds()
Returns canAddThresholds for the draggable object
int getDepth()
Returns the position on the axis
String getDescription()
Returns the description for this item
String getFirstElement()
Returns the first element ID for the attribute
String getHierarchyInfo()
Returns the hierarchy info for some target
String getImageName()
Returns the image name for this item.
int getMaxPosition()
Returns the max position on the target
String getObjectDescription()
Returns the object description
String getObjectID()
Returns the objectID for the draggable object
int getObjectSubType()
Returns the object sub type for the draggable object
int getObjectType()
Returns the object type for the draggable object
String getOrientation()
Returns the orientation for this item
String getOriginalStyleInfo()
Returns the original style info for some target
String getPointerInfo()
This method is deprecated. as of 8.0.000.179 we no longer use the px attribute
String getType()
Returns the type for this item
boolean isDraggable()
Returns whether the item is draggable
boolean isLocked()
Returns true if the cell is locked
boolean isMetrics()
Returns whether the item is "Metrics" title
boolean isTargetable()
Returns whether the item is targetable
void setAttFormID(String attFormID)
Sets the attribute form ID for the draggable object
void setAttFormList(String attFormList)
Sets the attribute form list for the draggable object
void setAttFormName(String attFormName)
Sets the attribute form ID for the draggable object
void setAttFormPosition(int attFormPosition)
Sets the form position within the attribute
void setAxisID(int axisID)
Sets the axis id of the item (either object or target)
void setCanAddThresholds(boolean canAddThresholds)
Sets canAddThresholds( for the draggable object
void setDepth(int depth)
Sets position on the axis
void setDescription(String description)
Sets the description for this item
void setDraggable(boolean isDraggable)
Sets whether the item is draggable
void setFirstElement(String firstElement)
Sets the first element ID for the attribute
void setHierarchyInfo(String hierarchyInfo)
Sets the hierarchyInfo for some target
void setImageName(String imageName)
Sets the image name for this item It doesn't include file path, but includes file postfix, for example, "Attribute.gif"
void setIsLocked(boolean value)
Sets the isLocked flag
void setMaxPosition(int maxPosition)
Sets the max position on the target
void setMetrics(boolean isMetrics)
Sets whether the item is "Metrics" title
void setObjectDescription(String objDescription)
Sets the object description for design mode
void setObjectID(String objectID)
Sets the objectID for the draggable object
void setObjectSubType(int objectSubType)
Sets the object sub type for the draggable object
void setObjectType(int objectType)
Sets the object type for the draggable object
void setOrientation(String orientation)
Sets the orientation for this item
void setOriginalStyleInfo(String originalStyleInfo)
Sets the original style info for some target
void setPointerInfo(String pointerInfo)
This method is deprecated. as of 8.0.000.179 we no longer use the px attribute
void setTargetable(boolean isTargetable)
Sets whether the item is targetable
void setType(String type)
Sets the type for this item
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public DragAndDropItem ()

no-arg constructor

Public Methods

public void addAttributes (Map atts)

Appends the attribute information required for the drag and drop functionality to be linked to an element on the HTML interface

public void addGridCellInitInfo (Map atts)

public void generateOutput (MarkupOutput mo)

generate the output for a drag item or a drop item

Parameters
mo the MarkupOutput object

public MarkupOutput generateOutput ()

generate the output for a drag item or a drop item

Returns

public String getAttFormId ()

Returns the attribute form ID for the draggable object

Returns
  • the attribute form ID for the draggable object

public String getAttFormList ()

Returns the attribute form list for the draggable object

Returns
  • the attribute form list for the draggable object

public String getAttFormName ()

Returns the attribute form Name for the draggable object

Returns
  • the attribute form Name for the draggable object

public int getAttFormPosition ()

Returns the form position within the attribute

Returns
  • form position within the attribute

public Map getAttributes ()

Generate the attribute information required for the drag and drop functionality to be linked to an element on the HTML interface

Returns
  • Map instance initialized with the attribute name - attribute value pairs information that should be used for enabling drag and drop functionality on an element.

public int getAxisID ()

Returns the axis id of the item (either object or target)

Returns
  • the axis id of the item

public boolean getCanAddThresholds ()

Returns canAddThresholds for the draggable object

Returns
  • canAddThresholds for the draggable object

public int getDepth ()

Returns the position on the axis

Returns
  • position on the axis

public String getDescription ()

Returns the description for this item

Returns
  • description for this item

public String getFirstElement ()

Returns the first element ID for the attribute

Returns
  • the first element ID for the attribute

public String getHierarchyInfo ()

Returns the hierarchy info for some target

Returns
  • the hierarchy info for some target

public String getImageName ()

Returns the image name for this item. It doesn't include file path, but includes file postfix, for example, "Attribute.gif"

Returns
  • image name for this item

public int getMaxPosition ()

Returns the max position on the target

Returns
  • max position on the target

public String getObjectDescription ()

Returns the object description

Returns
  • the object description

public String getObjectID ()

Returns the objectID for the draggable object

Returns
  • the objectID for the draggable object

public int getObjectSubType ()

Returns the object sub type for the draggable object

Returns
  • the object sub type for the draggable object

public int getObjectType ()

Returns the object type for the draggable object

Returns
  • the object type for the draggable object

public String getOrientation ()

Returns the orientation for this item

Returns
  • orientation for this item

public String getOriginalStyleInfo ()

Returns the original style info for some target

Returns
  • the original style info some target

public String getPointerInfo ()

This method is deprecated.
as of 8.0.000.179 we no longer use the px attribute

public String getType ()

Returns the type for this item

Returns
  • type for this item

public boolean isDraggable ()

Returns whether the item is draggable

Returns
  • if draggable

public boolean isLocked ()

Returns true if the cell is locked

Returns
  • true if the cell is locked

public boolean isMetrics ()

Returns whether the item is "Metrics" title

Returns
  • whether the item is "Metrics" title

public boolean isTargetable ()

Returns whether the item is targetable

Returns
  • if targetable

public void setAttFormID (String attFormID)

Sets the attribute form ID for the draggable object

Parameters
attFormID attribute form ID for the draggable object

public void setAttFormList (String attFormList)

Sets the attribute form list for the draggable object

Parameters
attFormList attribute form list for the draggable object

public void setAttFormName (String attFormName)

Sets the attribute form ID for the draggable object

Parameters
attFormName attribute form ID for the draggable object

public void setAttFormPosition (int attFormPosition)

Sets the form position within the attribute

Parameters
attFormPosition the form position within the attribute

public void setAxisID (int axisID)

Sets the axis id of the item (either object or target)

Parameters
axisID the axis id of the item

public void setCanAddThresholds (boolean canAddThresholds)

Sets canAddThresholds( for the draggable object

public void setDepth (int depth)

Sets position on the axis

Parameters
depth position on the axis

public void setDescription (String description)

Sets the description for this item

Parameters
description description for this item

public void setDraggable (boolean isDraggable)

Sets whether the item is draggable

Parameters
isDraggable draggable or not

public void setFirstElement (String firstElement)

Sets the first element ID for the attribute

Parameters
firstElement the first element ID for the attribute

public void setHierarchyInfo (String hierarchyInfo)

Sets the hierarchyInfo for some target

Parameters
hierarchyInfo the hierarchy Info for some target

public void setImageName (String imageName)

Sets the image name for this item It doesn't include file path, but includes file postfix, for example, "Attribute.gif"

Parameters
imageName image name for this item

public void setIsLocked (boolean value)

Sets the isLocked flag

Parameters
value the isLocked flag

public void setMaxPosition (int maxPosition)

Sets the max position on the target

Parameters
maxPosition max position on the target

public void setMetrics (boolean isMetrics)

Sets whether the item is "Metrics" title

Parameters
isMetrics whether the item is "Metrics" title

public void setObjectDescription (String objDescription)

Sets the object description for design mode

Parameters
objDescription the object description

public void setObjectID (String objectID)

Sets the objectID for the draggable object

Parameters
objectID the objectID for the draggable object

public void setObjectSubType (int objectSubType)

Sets the object sub type for the draggable object

Parameters
objectSubType the object sub type for the draggable object

public void setObjectType (int objectType)

Sets the object type for the draggable object

Parameters
objectType the object type for the draggable object

public void setOrientation (String orientation)

Sets the orientation for this item

Parameters
orientation orientation for this item

public void setOriginalStyleInfo (String originalStyleInfo)

Sets the original style info for some target

Parameters
originalStyleInfo the original style info for some target

public void setPointerInfo (String pointerInfo)

This method is deprecated.
as of 8.0.000.179 we no longer use the px attribute

public void setTargetable (boolean isTargetable)

Sets whether the item is targetable

Parameters
isTargetable targetable or not

public void setType (String type)

Sets the type for this item

Parameters
type type for this item