Package com.microstrategy.web.app.gui
Class DragAndDropItem
- java.lang.Object
-
- com.microstrategy.web.app.gui.DragAndDropItem
-
- All Implemented Interfaces:
EnumDragAndDropProperties
public class DragAndDropItem extends java.lang.Object implements EnumDragAndDropProperties
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- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.app.gui.EnumDragAndDropProperties
DND_AX, DND_AX_VALUE_COL, DND_AX_VALUE_FILTER, DND_AX_VALUE_FORMULA, DND_AX_VALUE_NONE, DND_AX_VALUE_PAGE, DND_AX_VALUE_REMOVE, DND_AX_VALUE_ROW, DND_DG, DND_DPT, DND_DS, DND_FE, DND_FRMID, DND_FRMLIST, DND_FRMNAME, DND_FRMPOS, DND_HR, DND_ID, DND_ILK, DND_IM, DND_MH, DND_MX, DND_OI, DND_OR, DND_OR_VALUE_H, DND_OR_VALUE_O, DND_OR_VALUE_V, DND_OS, DND_OST, DND_OT, DND_OTD, DND_PX, DND_TG, DND_TY, DND_TY_VALUE_ATT, DND_TY_VALUE_ATTFORM, DND_TY_VALUE_MV
-
-
Constructor Summary
Constructors Constructor Description DragAndDropItem()
no-arg constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addAttributes(java.util.Map atts)
Appends the attribute information required for the drag and drop functionality to be linked to an element on the HTML interfacevoid
addGridCellInitInfo(java.util.Map atts)
MarkupOutput
generateOutput()
generate the output for a drag item or a drop itemvoid
generateOutput(MarkupOutput mo)
generate the output for a drag item or a drop itemjava.lang.String
getAttFormId()
Returns the attribute form ID for the draggable objectjava.lang.String
getAttFormList()
Returns the attribute form list for the draggable objectjava.lang.String
getAttFormName()
Returns the attribute form Name for the draggable objectint
getAttFormPosition()
Returns the form position within the attributejava.util.Map
getAttributes()
Generate the attribute information required for the drag and drop functionality to be linked to an element on the HTML interfaceint
getAxisID()
Returns the axis id of the item (either object or target)boolean
getCanAddThresholds()
Returns canAddThresholds for the draggable objectint
getDepth()
Returns the position on the axisjava.lang.String
getDescription()
Returns the description for this itemjava.lang.String
getFirstElement()
Returns the first element ID for the attributejava.lang.String
getHierarchyInfo()
Returns the hierarchy info for some targetjava.lang.String
getImageName()
Returns the image name for this item.int
getMaxPosition()
Returns the max position on the targetjava.lang.String
getObjectDescription()
Returns the object descriptionjava.lang.String
getObjectID()
Returns the objectID for the draggable objectint
getObjectSubType()
Returns the object sub type for the draggable objectint
getObjectType()
Returns the object type for the draggable objectjava.lang.String
getOrientation()
Returns the orientation for this itemjava.lang.String
getOriginalStyleInfo()
Returns the original style info for some targetjava.lang.String
getPointerInfo()
Deprecated.as of 8.0.000.179 we no longer use the px attributejava.lang.String
getType()
Returns the type for this itemboolean
isDraggable()
Returns whether the item is draggableboolean
isLocked()
Returns true if the cell is lockedboolean
isMetrics()
Returns whether the item is "Metrics" titleboolean
isTargetable()
Returns whether the item is targetablevoid
setAttFormID(java.lang.String attFormID)
Sets the attribute form ID for the draggable objectvoid
setAttFormList(java.lang.String attFormList)
Sets the attribute form list for the draggable objectvoid
setAttFormName(java.lang.String attFormName)
Sets the attribute form ID for the draggable objectvoid
setAttFormPosition(int attFormPosition)
Sets the form position within the attributevoid
setAxisID(int axisID)
Sets the axis id of the item (either object or target)void
setCanAddThresholds(boolean canAddThresholds)
Sets canAddThresholds( for the draggable objectvoid
setDepth(int depth)
Sets position on the axisvoid
setDescription(java.lang.String description)
Sets the description for this itemvoid
setDraggable(boolean isDraggable)
Sets whether the item is draggablevoid
setFirstElement(java.lang.String firstElement)
Sets the first element ID for the attributevoid
setHierarchyInfo(java.lang.String hierarchyInfo)
Sets the hierarchyInfo for some targetvoid
setImageName(java.lang.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 flagvoid
setMaxPosition(int maxPosition)
Sets the max position on the targetvoid
setMetrics(boolean isMetrics)
Sets whether the item is "Metrics" titlevoid
setObjectDescription(java.lang.String objDescription)
Sets the object description for design modevoid
setObjectID(java.lang.String objectID)
Sets the objectID for the draggable objectvoid
setObjectSubType(int objectSubType)
Sets the object sub type for the draggable objectvoid
setObjectType(int objectType)
Sets the object type for the draggable objectvoid
setOrientation(java.lang.String orientation)
Sets the orientation for this itemvoid
setOriginalStyleInfo(java.lang.String originalStyleInfo)
Sets the original style info for some targetvoid
setPointerInfo(java.lang.String pointerInfo)
Deprecated.as of 8.0.000.179 we no longer use the px attributevoid
setTargetable(boolean isTargetable)
Sets whether the item is targetablevoid
setType(java.lang.String type)
Sets the type for this item
-
-
-
Method Detail
-
generateOutput
public MarkupOutput generateOutput()
generate the output for a drag item or a drop item- Returns:
- the
MarkupOutput
object to hold the output
-
getAttributes
public java.util.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.
- Since:
- MicroStrategy Web 8.0.1
-
addAttributes
public void addAttributes(java.util.Map atts)
Appends the attribute information required for the drag and drop functionality to be linked to an element on the HTML interface- Since:
- MicroStrategy Web 8.1.0
-
addGridCellInitInfo
public void addGridCellInitInfo(java.util.Map atts)
- Since:
- MicroStrategy Web 9.0.0
-
generateOutput
public void generateOutput(MarkupOutput mo)
generate the output for a drag item or a drop item- Parameters:
mo
- theMarkupOutput
object
-
isDraggable
public boolean isDraggable()
Returns whether the item is draggable- Returns:
- if draggable
-
setDraggable
public void setDraggable(boolean isDraggable)
Sets whether the item is draggable- Parameters:
isDraggable
- draggable or not
-
isTargetable
public boolean isTargetable()
Returns whether the item is targetable- Returns:
- if targetable
-
setTargetable
public void setTargetable(boolean isTargetable)
Sets whether the item is targetable- Parameters:
isTargetable
- targetable or not
-
getType
public java.lang.String getType()
Returns the type for this item- Returns:
- type for this item
-
setType
public void setType(java.lang.String type)
Sets the type for this item- Parameters:
type
- type for this item
-
getOrientation
public java.lang.String getOrientation()
Returns the orientation for this item- Returns:
- orientation for this item
-
setOrientation
public void setOrientation(java.lang.String orientation)
Sets the orientation for this item- Parameters:
orientation
- orientation for this item
-
getMaxPosition
public int getMaxPosition()
Returns the max position on the target- Returns:
- max position on the target
-
setMaxPosition
public void setMaxPosition(int maxPosition)
Sets the max position on the target- Parameters:
maxPosition
- max position on the target
-
getAxisID
public int getAxisID()
Returns the axis id of the item (either object or target)- Returns:
- the axis id of the item
-
setAxisID
public void setAxisID(int axisID)
Sets the axis id of the item (either object or target)- Parameters:
axisID
- the axis id of the item
-
getDepth
public int getDepth()
Returns the position on the axis- Returns:
- position on the axis
-
setDepth
public void setDepth(int depth)
Sets position on the axis- Parameters:
depth
- position on the axis
-
getDescription
public java.lang.String getDescription()
Returns the description for this item- Returns:
- description for this item
-
setDescription
public void setDescription(java.lang.String description)
Sets the description for this item- Parameters:
description
- description for this item
-
getImageName
public java.lang.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
-
setImageName
public void setImageName(java.lang.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
-
getFirstElement
public java.lang.String getFirstElement()
Returns the first element ID for the attribute- Returns:
- the first element ID for the attribute
-
setFirstElement
public void setFirstElement(java.lang.String firstElement)
Sets the first element ID for the attribute- Parameters:
firstElement
- the first element ID for the attribute
-
getObjectID
public java.lang.String getObjectID()
Returns the objectID for the draggable object- Returns:
- the objectID for the draggable object
-
setObjectID
public void setObjectID(java.lang.String objectID)
Sets the objectID for the draggable object- Parameters:
objectID
- the objectID for the draggable object
-
getCanAddThresholds
public boolean getCanAddThresholds()
Returns canAddThresholds for the draggable object- Returns:
- canAddThresholds for the draggable object
-
setCanAddThresholds
public void setCanAddThresholds(boolean canAddThresholds)
Sets canAddThresholds( for the draggable object- Parameters:
canAddThresholds
- ( if the current column supports thresholds
-
getObjectType
public int getObjectType()
Returns the object type for the draggable object- Returns:
- the object type for the draggable object
-
setObjectType
public void setObjectType(int objectType)
Sets the object type for the draggable object- Parameters:
objectType
- the object type for the draggable object
-
setObjectSubType
public void setObjectSubType(int objectSubType)
Sets the object sub type for the draggable object- Parameters:
objectSubType
- the object sub type for the draggable object- Since:
- MicroStrategy Web 8.1.0
-
getObjectSubType
public int getObjectSubType()
Returns the object sub type for the draggable object- Returns:
- the object sub type for the draggable object
- Since:
- MicroStrategy Web 8.1.0
-
getHierarchyInfo
public java.lang.String getHierarchyInfo()
Returns the hierarchy info for some target- Returns:
- the hierarchy info for some target
-
setHierarchyInfo
public void setHierarchyInfo(java.lang.String hierarchyInfo)
Sets the hierarchyInfo for some target- Parameters:
hierarchyInfo
- the hierarchy Info for some target
-
isMetrics
public boolean isMetrics()
Returns whether the item is "Metrics" title- Returns:
- whether the item is "Metrics" title
-
setMetrics
public void setMetrics(boolean isMetrics)
Sets whether the item is "Metrics" title- Parameters:
isMetrics
- whether the item is "Metrics" title
-
getPointerInfo
public java.lang.String getPointerInfo()
Deprecated.as of 8.0.000.179 we no longer use the px attribute
-
setPointerInfo
public void setPointerInfo(java.lang.String pointerInfo)
Deprecated.as of 8.0.000.179 we no longer use the px attribute
-
getOriginalStyleInfo
public java.lang.String getOriginalStyleInfo()
Returns the original style info for some target- Returns:
- the original style info some target
-
setOriginalStyleInfo
public void setOriginalStyleInfo(java.lang.String originalStyleInfo)
Sets the original style info for some target- Parameters:
originalStyleInfo
- the original style info for some target
-
getAttFormPosition
public int getAttFormPosition()
Returns the form position within the attribute- Returns:
- form position within the attribute
- Since:
- MicroStrategy Web 8.0.0
-
setAttFormPosition
public void setAttFormPosition(int attFormPosition)
Sets the form position within the attribute- Parameters:
attFormPosition
- the form position within the attribute- Since:
- MicroStrategy Web 8.0.0
-
getAttFormId
public java.lang.String getAttFormId()
Returns the attribute form ID for the draggable object- Returns:
- the attribute form ID for the draggable object
- Since:
- MicroStrategy Web 8.0.0
-
setAttFormID
public void setAttFormID(java.lang.String attFormID)
Sets the attribute form ID for the draggable object- Parameters:
attFormID
- attribute form ID for the draggable object- Since:
- MicroStrategy Web 8.0.0
-
getAttFormName
public java.lang.String getAttFormName()
Returns the attribute form Name for the draggable object- Returns:
- the attribute form Name for the draggable object
- Since:
- MicroStrategy Web 8.0.0
-
setAttFormName
public void setAttFormName(java.lang.String attFormName)
Sets the attribute form ID for the draggable object- Parameters:
attFormName
- attribute form ID for the draggable object- Since:
- MicroStrategy Web 8.0.0
-
getAttFormList
public java.lang.String getAttFormList()
Returns the attribute form list for the draggable object- Returns:
- the attribute form list for the draggable object
- Since:
- MicroStrategy Web 8.0.0
-
setAttFormList
public void setAttFormList(java.lang.String attFormList)
Sets the attribute form list for the draggable object- Parameters:
attFormList
- attribute form list for the draggable object- Since:
- MicroStrategy Web 8.0.0
-
getObjectDescription
public java.lang.String getObjectDescription()
Returns the object description- Returns:
- the object description
- Since:
- MicroStrategy Web 8.0.0
-
setObjectDescription
public void setObjectDescription(java.lang.String objDescription)
Sets the object description for design mode- Parameters:
objDescription
- the object description- Since:
- MicroStrategy Web 8.0.0
-
isLocked
public boolean isLocked()
Returns true if the cell is locked- Returns:
- true if the cell is locked
- Since:
- MicroStrategy Web 8.0.0
-
setIsLocked
public void setIsLocked(boolean value)
Sets the isLocked flag- Parameters:
value
- the isLocked flag- Since:
- MicroStrategy Web 8.0.0
-
-