com.sapportals.htmlb

Class DragSource

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.Container
          com.sapportals.htmlb.DragSource

public class DragSource

extends Container

The DragSource is used to make a html business for java control dragable. The DragSource is a container which can contain any htmlb control.
In Netscape Drag-and-drop is only possible within the same form. Drag-and-drop between different forms or windows is only supported for Internet Explorer.
You can drag any html element inside the DragSource, but it is not possible to drag any emty space inside DragSource.
Drag-and-Drop is supported for Internet Explorer and Netscape 6 and above.

Copyright 2004 SAP AG

Field Summary

static String

UI_ID

Fields inherited from class com.sapportals.htmlb.Container

elements

Constructor Summary

DragSource(String name)
Creates a DragSource with a specific name

Method Summary

void	addFlavour(String flavour) adds a flavour to the dragSource.
String	getColumnKey() this method returns the columnKey, which was set by the method setColumnKey().
DropTargetDesign	getDropTargetDesign() gets the design of the dropTargets during a drag-and-drop operation.
ArrayList	getFlavours() retrieves the list of flavours from the dragSource.
String	getFlavoursAsString() internal use only
Scope	getScope() the scope determines if drag-and-drop is possible only inside the current form or in the whole browser.
String	getSourceContainerName() this method returns the ConatinerName, which was set by the method setSourceContainerName
String	getUI() get a identification String for the renderer that is unique across all supported components.
String	getValue() retrieves the value which has to be transfered from the dragSource to the dropTarget during a drag-and-drop operation.
String	getWidth() returns the width of the container
void	removeAllFlavours() removes all flavours from the dragSource.
void	removeFlavour(String flavour) removes a flavour from the dragSource.
void	setColumnKey(String columnKey) this method can be used to identify the column of the dragSource, when the dragSource is used inside an own cellRenderer of a TableView.
void	setDropTargetDesign(DropTargetDesign dropTargetDesign) sets the design of the dropTargets during a drag-and-drop operation.
void	setFlavours(ArrayList flavours) sets the list of flavours of the dragSource.
void	setScope(Scope scope) the scope determines if drag-and-drop is possible only inside the current form or in the whole browser.
void	setSourceContainerName(String sourceObjectName) this method can be used to identify the source container of the dragSource, when the dragSource is used inside an own cellRenderer of a TableView or inside a Tree.
void	setValue(String value) sets the value which has to be transfered from the dragSource to the dropTarget during a drag-and-drop operation.
void	setWidth(String width) sets the width of the container

Methods inherited from class com.sapportals.htmlb.Container

addComponent, addRawText, addText, getChildCount, iterator, preRender, removeComponent, render

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromPageContext, initFromShortId, initializeFromId, isJsObjectNeeded, render, renderAsString, requiresForm, setId, setJsObjectNeeded, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UI_ID

public static final String UI_ID

See Also:

Constant Field Values

Constructor Detail

DragSource

public DragSource(String name)

Creates a DragSource with a specific name

Parameters:

name - the name of the dragSource

Method Detail

getUI

public String getUI()

get a identification String for the renderer that is unique across all supported components. E.g. you could simply return the class name of the component class. The reason for using a separate method and not some internal reflection method is that you can more easily extend the functionality or your Component class without having to rewrite the view class.

Specified by:

getUI in class Component

Returns:

a unique identification string for this Component

addFlavour

public void addFlavour(String flavour)

adds a flavour to the dragSource. Flavours are used to identify possible dropTargets. Drag-and-Drop is only possible if the dragSource contains at least one flavour of the dropTarget. A flavour can be any string.

Parameters:

flavour - the flavour to add

removeFlavour

public void removeFlavour(String flavour)

removes a flavour from the dragSource. Flavours are used to identify possible dropTargets. Drag-and-Drop is only possible if the dragSource contains at least one flavour of the dropTarget. A flavour can be any string.

Parameters:

flavour - the flavour to remove

removeAllFlavours

public void removeAllFlavours()

removes all flavours from the dragSource. Flavours are used to identify possible dropTargets. Drag-and-Drop is only possible if the dragSource contains at least one flavour of the dropTarget. A flavour can be any string.

getFlavours

public ArrayList getFlavours()

retrieves the list of flavours from the dragSource. Flavours are used to identify possible dropTargets. Drag-and-Drop is only possible if the dragSource contains at least one flavour of the dropTarget. A flavour can be any string.

Returns:

the list of flavours

setFlavours

public void setFlavours(ArrayList flavours)

sets the list of flavours of the dragSource. Flavours are used to identify possible dropTargets. Drag-and-Drop is only possible if the dragSource contains at least one flavour of the dropTarget. A flavour can be any string.

Parameters:

flavours - the list of flavours

setValue

public void setValue(String value)

sets the value which has to be transfered from the dragSource to the dropTarget during a drag-and-drop operation. This value will be available in the DropEvent-handler.

Parameters:

value - the value to be transfered to the dropTarget.

getValue

public String getValue()

retrieves the value which has to be transfered from the dragSource to the dropTarget during a drag-and-drop operation.

Returns:

the value to be transfered to the dropTarget.

setColumnKey

public void setColumnKey(String columnKey)

this method can be used to identify the column of the dragSource, when the dragSource is used inside an own cellRenderer of a TableView. This column name will be passed to the dropEvent.

getColumnKey

public String getColumnKey()

this method returns the columnKey, which was set by the method setColumnKey().

setSourceContainerName

public void setSourceContainerName(String sourceObjectName)

this method can be used to identify the source container of the dragSource, when the dragSource is used inside an own cellRenderer of a TableView or inside a Tree. This name will be passed to the DropEvent.

getSourceContainerName

public String getSourceContainerName()

this method returns the ConatinerName, which was set by the method setSourceContainerName

setScope

public void setScope(Scope scope)

the scope determines if drag-and-drop is possible only inside the current form or in the whole browser. For Netscape only the scope FORM is supported

getScope

public Scope getScope()

the scope determines if drag-and-drop is possible only inside the current form or in the whole browser. For Netscape only the scope FORM is supported

setDropTargetDesign

public void setDropTargetDesign(DropTargetDesign dropTargetDesign)

sets the design of the dropTargets during a drag-and-drop operation. if selectDropTargets is true, all possible dropTargets will be marked using the DropTargetDesign. Default is DropTargetDesign.BORDERED.

Parameters:

dropTargetDesign - design of the dropTargets during a drag-and-drop operation

getDropTargetDesign

public DropTargetDesign getDropTargetDesign()

gets the design of the dropTargets during a drag-and-drop operation. if selectDropTargets is true, all possible dropTargets will be marked using the DropTargetDesign. Default is DropTargetDesign.BORDERED.

Returns:

design of the dropTargets during a drag-and-drop operation

getWidth

public String getWidth()

returns the width of the container

Returns:

the width of the container

setWidth

public void setWidth(String width)

sets the width of the container

Parameters:

width - the width of the container

getFlavoursAsString

public String getFlavoursAsString()

internal use only