com.axemble.vdoc.sdk.interfaces.ui.designer

Interface IDesignContainer

All Known Subinterfaces:

IDesignForm, IDesignWorkflow

public interface IDesignContainer

Author:

vlygeros

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDesignContainer.SupportedEventTypes Specific event types.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SIZE Design container maximum size in pixel
static int	TOP_AND_LEFT_MARGIN Design container margin in pixel

Method Summary

Modifier and Type	Method and Description
void	addChild(IDesignElement designElement) Adds a IDesignElement object to the container.
IDesignElement	getChild(String id) Gets a specific IDesignElement object by its identifier.
Map<String,IDesignElement>	getChildren() Gets the children design objects.
ICounterManager	getCounterManager() Gets the associated counter manager.
String	getId() Gets the identifier of the designed object.
IWidget	getPrintHeader() Returns IWidget header for print mode
ISelectionManager	getSelectionManager() Gets the associated selection manager.
String	getUniqueName() Gets the unique name representing the designed object.
boolean	isDirty() Checks whether a container is dirty and needs to be rendered.
boolean	isHelpMode() Returns true if the help mode active
boolean	isModified() Returns true if the container has been modified
boolean	isMultipleSelectionMode() Returns true if multiple selection mode is active, false otherwise
boolean	isPrintMode() Returns true if the print mode active
void	load() Allows to load the contained designed objects.
void	setCurrentLeftTab(String name) Sets current tab in navigator
void	setDirty(boolean isDirty) Sets the container dirty flag.
void	setHelpMode(boolean helpMode) Sets the help mode flag
void	setModified(boolean modified) Sets the modification flag
void	setMultipleSelectionMode(boolean multipleSelectionMode) Sets the multiple selection mode
void	setPrintMode(boolean printMode) Sets the print mode flag

Field Detail

MAX_SIZE

static final int MAX_SIZE

Design container maximum size in pixel

See Also:

Constant Field Values

TOP_AND_LEFT_MARGIN

static final int TOP_AND_LEFT_MARGIN

Design container margin in pixel

See Also:

Constant Field Values

Method Detail

getId

String getId()

Gets the identifier of the designed object.

Returns:

A java.lang.String object.

getUniqueName

String getUniqueName()

Gets the unique name representing the designed object.

Returns:

A java.lang.String object.

load

void load()

Allows to load the contained designed objects.

getSelectionManager

ISelectionManager getSelectionManager()

Gets the associated selection manager.

Returns:

A ISelectionManager object.

getCounterManager

ICounterManager getCounterManager()

Gets the associated counter manager.

Returns:

A ICounterManager object.

getChildren

Map<String,IDesignElement> getChildren()

Gets the children design objects.

Returns:

A java.util.Map containing IDesignElement objects.

getChild

IDesignElement getChild(String id)

Gets a specific IDesignElement object by its identifier.

Parameters:

id - The identifier in memory.

Returns:

A IDesignElement object.

addChild

void addChild(IDesignElement designElement)

Adds a IDesignElement object to the container.

Parameters:

designElement - The design object to add.

isDirty

boolean isDirty()

Checks whether a container is dirty and needs to be rendered.

Returns:

true if the container is dirty, false otherwise.

setDirty

void setDirty(boolean isDirty)

Sets the container dirty flag.

Parameters:

isDirty - The new value to set to.

isMultipleSelectionMode

boolean isMultipleSelectionMode()

Returns true if multiple selection mode is active, false otherwise

Returns:

the multipleSelectionMode

setMultipleSelectionMode

void setMultipleSelectionMode(boolean multipleSelectionMode)

Sets the multiple selection mode

Parameters:

multipleSelectionMode - the multipleSelectionMode to set : true sets the mode to multiple selection, false sets the mode to single selection

isModified

boolean isModified()

Returns true if the container has been modified

Returns:

true if the container has been modified

setModified

void setModified(boolean modified)

Sets the modification flag

Parameters:

modified -

isPrintMode

boolean isPrintMode()

Returns true if the print mode active

Returns:

true if the print mode active

setPrintMode

void setPrintMode(boolean printMode)

Sets the print mode flag

Parameters:

printMode -

getPrintHeader

IWidget getPrintHeader()

Returns IWidget header for print mode

Returns:

Widget header for print mode

isHelpMode

boolean isHelpMode()

Returns true if the help mode active

Returns:

true if the help mode active

setHelpMode

void setHelpMode(boolean helpMode)

Sets the help mode flag

Parameters:

helpMode -

setCurrentLeftTab

void setCurrentLeftTab(String name)

Sets current tab in navigator

Parameters:

name -