Class Embedded

Class Embedded
Prev	Chapter 17. Package com.itmill.toolkit.ui	Next

Synopsis

Since: 3.0

Inheritance Path. java.lang.Object-> com.itmill.toolkit.ui.AbstractComponent -> com.itmill.toolkit.ui.Embedded

Embedded()

Creates a new empty Embedded object.

Embedded(String)

Creates a new empty Embedded object with caption.

Embedded(String, Resource)

Creates a new Embedded object whose contents is loaded from given resource. The dimensions are assumed if possible. The type is guessed from resource.

TYPE_IMAGE

Image types

TYPE_OBJECT

General object type

getArchive()

Parameters

return: String

Returns the archive attribute.

getClassId()

Parameters

return: String

Returns the classId attribute.

getCodebase()

Parameters

return: String

Returns the codebase, the root-path used to access resources with relative paths.

getCodetype()

Parameters

return: String

Returns the MIME-Type of the code.

getHeight()

Parameters

return: The height in units specified by heightUnits property.

Returns the visual height of the object. Default height is -1, which is interpreted as "unspecified".

getHeightUnits()

See Also: getHeightUnits()

Get height property units. Default units are Sizeable.UNITS_PIXELS .

getMimeType()

Parameters

return: String

Returns the MIME-Type of the object

getParameter(String)

Parameters

return: Value of parameter or null if not found.

Get the value of an object parameter. Parameters are optional information, and they are passed to the instantiated object. Parameters are are stored as name value pairs.

getParameterNames()

Parameters

return: Iterator of parameters names.

Get embedded object parameter names.

getSource()

Parameters

return: Resource

Get the resource contained in the embedded object.

getStandby()

Parameters

return: String

Returns the standby text displayed when the object is loading.

getTag()

Parameters

return: Component UIDL tag as string.

Get component UIDL tag.

getType()

Parameters

return: int

Get the type of the embedded object.

This can be one of the following:

TYPE_OBJECT (This is the default)
TYPE_IMAGE

getWidth()

Parameters

return: The width in units specified by widthUnits property.

Returns the visual width of the object. Default width is -1, which is interpreted as "unspecified".

getWidthUnits()

See Also: getWidthUnits()

Get width property units. Default units are Sizeable.UNITS_PIXELS .

paintContent(PaintTarget)

Invoked when the component state should be painted

removeParameter(String)

Parameters

name: - The name of the parameter to remove.

Remove an object parameter from the list.

setArchive(String)

Parameters

archive: The archive string to set

Sets the archive attribute.

setClassId(String)

Parameters

classId: The classId to set

Sets the classId attribute.

setCodebase(String)

Parameters

codebase: The codebase to set

Sets the codebase, the root-path used to access resources with relative paths.

setCodetype(String)

Parameters

codetype: The codetype to set

Sets the codetype, the MIME-Type of the code.

setHeight(int)

Parameters

height: The height in units specified by heightUnits property.

Sets the visual height of the object. Default height is -1, which is interpreted as "unspecified".

setHeightUnits(int)

See Also: setHeightUnits(int)

Set height property units.

setMimeType(String)

Parameters

mimeType: The mimeType to set

Sets the mimeType, the MIME-Type of the object.

setParameter(String, String)

Parameters

name: - The name of the parameter.
value: - The value of the parameter.

Set an object parameter. Parameters are optional information, and they are passed to the instantiated object. Parameters are are stored as name value pairs. This overrides the previous value assigned to this parameter.

setSource(Resource)

Parameters

source: The source to set

Set the object source resource. The dimensions are assumed if possible. The type is guessed from resource.

setStandby(String)

Parameters

standby: The standby to set

Sets the standby, the text to display while loading the object.

setType(int)

Parameters

type: The type to set

Sets the object type.

This can be one of the following:

TYPE_OBJECT (This is the default)
TYPE_IMAGE

setWidth(int)

Parameters

width: The width in units specified by widthUnits property.

Sets the visual width of the object. Default width is -1, which is interpreted as "unspecified".

setWidthUnits(int)

See Also: setWidthUnits(int)

Set width property units.

Prev	Up	Next
Class DateField	Home	Interface Field