Package de.xima.fc.gui.model.designer

Class TabModel

java.lang.Object

de.xima.fc.gui.model.designer.TabModel

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TabModel.IFrame, TabModel.Include

public abstract class TabModel
extends Object
implements Serializable

POJO model for a tab in the designer, such as the workflow or form editor tab.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TabModel.IFrame	Component model showing its content as an iframe in the main window view.
static class	TabModel.Include	Component model showing its content as a ui:include in the main window view.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
TabError	getError()
IGuiIcon	getIcon()
String	getId()
String	getLabel()
String	getParentId()
String	getParentLabel()
String	getTitle()
EDesignerTabType	getType()
int	hashCode()
boolean	isClosable()
boolean	isDisabled()
boolean	isHasUnsavedChanges()
boolean	isOpen()
void	setError(TabError error)
void	setHasUnsavedChanges(boolean hasUnsavedChanges)
void	setOpen(boolean open)

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getError

public TabError getError()

Returns:

The error that occurred in the tab, or null when no error.

getIcon

public IGuiIcon getIcon()

Returns:

The icon for this tab that is shown next to the tab. Should not be null, only GuiIcon.EMPTY.

getId

public String getId()

Returns:

Unique ID of the tab.

getLabel

public String getLabel()

Returns:

Label of the tab that is shown on the menu.

getParentId

public String getParentId()

Returns:

ID of the parent that contains this tab menu entry. Used for grouping when showing a list of available tabs.

getParentLabel

public String getParentLabel()

Returns:

Label of the parent / group that contains this tab menu entry. Used for grouping when showing a list of available tabs.

getTitle

public String getTitle()

Returns:

Title (tooltip) of the tab that is shown on the menu.

getType

public EDesignerTabType getType()

Returns:

How the tab should be rendered ,e.g. as an iframe or as a ui:include etc.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isClosable

public boolean isClosable()

Returns:

Whether this tab can be closed or must always stay opened.

isDisabled

public boolean isDisabled()

Returns:

Whether this tab is disabled and cannot be opened.

isHasUnsavedChanges

public boolean isHasUnsavedChanges()

Returns:

Whether this tab has got any unsaved changes.

isOpen

public boolean isOpen()

Returns:

Whether this tab is currently opened (displayed).

setError

public void setError(TabError error)

Parameters:

error - The error that occurred in the tab, or null when no error.

setHasUnsavedChanges

public void setHasUnsavedChanges(boolean hasUnsavedChanges)

Parameters:

hasUnsavedChanges - Whether this tab has got any unsaved changes.

setOpen

public void setOpen(boolean open)

Parameters:

open - Whether this tab is currently opened (displayed).