Interface IDesignContainer
- All Known Subinterfaces:
IDesignForm
,IDesignWorkflow
public interface IDesignContainer
- Author:
- vlygeros
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Specific event types. -
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Design container maximum size in pixelstatic final int
Design container margin in pixel -
Method Summary
Modifier and TypeMethodDescriptionvoid
addChild
(IDesignElement designElement) Adds aIDesignElement
object to the container.Gets a specificIDesignElement
object by its identifier.Gets the children design objects.Gets the associated counter manager.getId()
Gets the identifier of the designed object.Returns IWidget header for print modeGets the associated selection manager.Gets the unique name representing the designed object.boolean
isDirty()
Checks whether a container is dirty and needs to be rendered.boolean
Returns true if the help mode activeboolean
Returns true if the container has been modifiedboolean
Returns true if multiple selection mode is active, false otherwiseboolean
Returns true if the print mode activevoid
load()
Allows to load the contained designed objects.void
setCurrentLeftTab
(String name) Sets current tab in navigatorvoid
setDirty
(boolean isDirty) Sets the container dirty flag.void
setHelpMode
(boolean helpMode) Sets the help mode flagvoid
setModified
(boolean modified) Sets the modification flagvoid
setMultipleSelectionMode
(boolean multipleSelectionMode) Sets the multiple selection modevoid
setPrintMode
(boolean printMode) Sets the print mode flag
-
Field Details
-
MAX_SIZE
static final int MAX_SIZEDesign container maximum size in pixel- See Also:
-
TOP_AND_LEFT_MARGIN
static final int TOP_AND_LEFT_MARGINDesign container margin in pixel- See Also:
-
-
Method Details
-
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
Gets a specificIDesignElement
object by its identifier.- Parameters:
id
- The identifier in memory.- Returns:
- A
IDesignElement
object.
-
addChild
Adds aIDesignElement
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
Sets current tab in navigator- Parameters:
name
-
-