com.sapportals.htmlb

Class DropTarget

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

public class DropTarget

extends Container

The DropTarget is used to make a html business for java control dropable. The DropTarget 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 drop on every html-element inside the DropTarget, but its not possible to drop on an emty space inside the DropTarget. 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

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

Method Summary

void	addFlavour(String flavour) adds a flavour to the dropTarget.
ArrayList	getFlavours() retrieves the list of flavours from the dropTarget.
String	getFlavoursAsString() internal use only
String	getOnDrop() retrieves the event handler for the DropEvent.
String	getUI() get a identification String for the renderer that is unique across all supported components.
String	getValue() retrieves the value to be passed to the DropEvent.
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 dropTarget.
void	setFlavours(ArrayList flavours) sets the list of flavours from the dropTarget.
void	setOnDrop(String onDrop) sets the event handler for the DropEvent.
void	setValue(String value) sets the value to be passed to the DropEvent.
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

DropTarget

public DropTarget(String name)

Creates a DropTarget 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 dropTarget. 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 dropTarget. 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 dropTarget. 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 from the dropTarget. 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

setOnDrop

public void setOnDrop(String onDrop)

sets the event handler for the DropEvent.

Parameters:

onDrop - event handler for the DropEvent.

getOnDrop

public String getOnDrop()

retrieves the event handler for the DropEvent.

Returns:

the event handler for the DropEvent.

setValue

public void setValue(String value)

sets the value to be passed to the DropEvent.

Parameters:

value - the value to bes passed to the DropEvent.

getValue

public String getValue()

retrieves the value to be passed to the DropEvent.

Returns:

the value to bes passed to the DropEvent.

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