com.haulmont.cuba.gui.components

Class AbstractFrame

java.lang.Object

com.haulmont.cuba.gui.components.AbstractFrame

All Implemented Interfaces:

Component, Component.ActionsHolder, Component.BelongToFrame, Component.Container, Component.HasCaption, Component.HasIcon, Component.Margin, Component.OrderedContainer, Component.Spacing, Component.Wrapper, ExpandingLayout, Frame, Frame.Wrapper

Direct Known Subclasses:

AbstractWindow, AttributePermissionsFrame, CategoryAttrsFrame, ConditionFrame, CreditsFrame, EntityDiffViewer, EntityOpenHistoryFrame, EntityPermissionsFrame, LicenseFrame, LocalizedNameFrame, RuntimePropertiesFrame, ScreenPermissionsFrame, SpecificPermissionsFrame, UiPermissionsFrame

public class AbstractFrame
extends java.lang.Object
implements Frame, Frame.Wrapper, Component.Wrapper, Component.OrderedContainer

Base class for frame controllers.

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Frame

Frame.MessageMode, Frame.MessageType, Frame.NotificationType, Frame.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.ExpandingLayout

ExpandingLayout.ExpandDirection

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener

Field Summary

Fields inherited from interface com.haulmont.cuba.gui.components.Frame

NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
AbstractFrame()

Method Summary

Modifier and Type	Method and Description
void	add(Component component)
void	add(Component childComponent, int index)
void	addAction(Action action) Add an action to the component
void	addAction(Action action, int index) Add an action to the component with index.
void	addStyleName(java.lang.String styleName) Adds one or more style names to this component.
void	expand(Component component)
void	expand(Component component, java.lang.String height, java.lang.String width)
Action	getAction(java.lang.String id)
java.util.Collection<Action>	getActions()
Component.Alignment	getAlignment()
java.lang.String	getCaption()
<T> T	getCompanion()
java.lang.Object	getComponent()
Component	getComponent(int index) Returns the component at the given position.
Component	getComponent(java.lang.String id) Get component belonging to the whole components tree below this container.
java.util.Collection<Component>	getComponents() Get all components belonging to the whole components tree below this container
java.lang.Object	getComposition()
FrameContext	getContext()
java.lang.String	getDebugId()
java.lang.String	getDescription()
DialogParams	getDialogParams() Deprecated. Use WindowManager.OpenType or Window.getDialogOptions() from screen controller
DsContext	getDsContext()
ExpandingLayout.ExpandDirection	getExpandDirection()
Frame	getFrame()
float	getHeight() Get component height in Component.getHeightUnits()
int	getHeightUnits() Height units: Component.UNITS_PIXELS, Component.UNITS_PERCENTAGE
java.lang.String	getIcon() Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
java.lang.String	getId() Component ID as defined in id attribute
MarginInfo	getMargin()
java.lang.String	getMessagesPack()
Component	getOwnComponent(java.lang.String id) Get component directly owned by this container.
java.util.Collection<Component>	getOwnComponents() Get all components directly owned by this container
Component	getParent()
Component	getRegisteredComponent(java.lang.String id) INTERNAL.
boolean	getSpacing()
java.lang.String	getStyleName() Styles implementation is client-type-specific.
java.util.List<org.springframework.context.ApplicationListener>	getUiEventListeners() INTERNAL.
float	getWidth() Get component width in Component.getWidthUnits()
int	getWidthUnits() Width units: Component.UNITS_PIXELS, Component.UNITS_PERCENTAGE
Frame	getWrappedFrame()
int	indexOf(Component component)
void	init(java.util.Map<java.lang.String,java.lang.Object> params) Called by the framework after creation of all components and before showing the screen.
boolean	isEnabled() Are the component and its parent enabled?
boolean	isEnabledItself() Is the component enabled regardless of the parent?
boolean	isExpanded(Component component)
boolean	isResponsive() Is the component responsive?
boolean	isValid() Check validity by invoking validators on all components which support them.
boolean	isVisible() Are the component and its parent visible?
boolean	isVisibleItself() Is the component visible regardless of the parent?
AbstractEditor	openEditor(Entity item, WindowManager.OpenType openType) Open an edit screen for entity instance.
AbstractEditor	openEditor(Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params) Open an edit screen for entity instance.
AbstractEditor	openEditor(Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params, Datasource parentDs) Open an edit screen for entity instance.
AbstractEditor	openEditor(java.lang.String windowAlias, Entity item, WindowManager.OpenType openType) Open an edit screen.
AbstractEditor	openEditor(java.lang.String windowAlias, Entity item, WindowManager.OpenType openType, Datasource parentDs) Open an edit screen.
AbstractEditor	openEditor(java.lang.String windowAlias, Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params) Open an edit screen.
AbstractEditor	openEditor(java.lang.String windowAlias, Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params, Datasource parentDs) Open an edit screen.
AbstractFrame	openFrame(Component parent, java.lang.String windowAlias) Load a frame registered in screens.xml and optionally show it inside a parent component of this frame.
AbstractFrame	openFrame(Component parent, java.lang.String windowAlias, java.util.Map<java.lang.String,java.lang.Object> params) Load a frame registered in screens.xml and optionally show it inside a parent component of this frame.
AbstractLookup	openLookup(java.lang.Class<? extends Entity> entityClass, Window.Lookup.Handler handler, WindowManager.OpenType openType) Open a lookup screen.
AbstractLookup	openLookup(java.lang.Class<? extends Entity> entityClass, Window.Lookup.Handler handler, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params) Open a lookup screen.
AbstractLookup	openLookup(java.lang.String windowAlias, Window.Lookup.Handler handler, WindowManager.OpenType openType) Open a lookup screen.
AbstractLookup	openLookup(java.lang.String windowAlias, Window.Lookup.Handler handler, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params) Open a lookup screen.
AbstractWindow	openWindow(java.lang.String windowAlias, WindowManager.OpenType openType) Open a simple screen.
AbstractWindow	openWindow(java.lang.String windowAlias, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params) Open a simple screen.
void	registerComponent(Component component) INTERNAL.
void	remove(Component component)
void	removeAction(Action action) Remove the action from the component
void	removeAction(java.lang.String id) Remove the action by its ID.
void	removeAll()
void	removeAllActions() Remove all actions from the component
void	removeStyleName(java.lang.String styleName) Removes one or more style names from component.
void	requestFocus() Set focus to this component
void	resetExpanded()
void	setAlignment(Component.Alignment alignment)
void	setCaption(java.lang.String caption)
void	setCompanion(java.lang.Object companion) INTERNAL.
void	setContext(FrameContext ctx) INTERNAL.
void	setDebugId(java.lang.String id) INTERNAL.
void	setDescription(java.lang.String description)
void	setDsContext(DsContext dsContext) INTERNAL.
void	setEnabled(boolean enabled) Set component enabled state
void	setFrame(Frame frame)
void	setHeight(java.lang.String height) Set component height in Component.getHeightUnits()
void	setIcon(java.lang.String icon) Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
void	setIconFromSet(Icons.Icon icon) Set an icon from an icon set.
void	setId(java.lang.String id) Set component ID
void	setMargin(MarginInfo marginInfo)
void	setMessagesPack(java.lang.String name) Set message pack for this frame.
void	setParent(Component parent) INTERNAL. Component.Container.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.
void	setResponsive(boolean responsive) Set component to be responsive by width and height.
void	setSpacing(boolean enabled)
void	setStyleName(java.lang.String styleName) Sets one or more style names of the component, replacing any previous styles.
void	setUiEventListeners(java.util.List<org.springframework.context.ApplicationListener> uiEventListeners) INTERNAL.
void	setVisible(boolean visible) Set component visibility
void	setWidth(java.lang.String width) Set component width in Component.getWidthUnits()
void	setWrappedFrame(Frame frame) INTERNAL.
void	showMessageDialog(java.lang.String title, java.lang.String message, Frame.MessageType messageType) Show message dialog with title and message.
void	showNotification(java.lang.String caption) Show notification with Frame.NotificationType.HUMANIZED.
void	showNotification(java.lang.String caption, Frame.NotificationType type) Show notification.
void	showNotification(java.lang.String caption, java.lang.String description, Frame.NotificationType type) Show notification with caption and description.
void	showOptionDialog(java.lang.String title, java.lang.String message, Frame.MessageType messageType, Action[] actions) Show options dialog with title and message.
void	showOptionDialog(java.lang.String title, java.lang.String message, Frame.MessageType messageType, java.util.List<Action> actions) Show options dialog with title and message.
void	showValidationErrors(ValidationErrors errors) Show validation errors alert.
void	showWebPage(java.lang.String url, java.util.Map<java.lang.String,java.lang.Object> params) Open a web page in browser.
void	unregisterComponent(Component component) INTERNAL.
<X> X	unwrap(java.lang.Class<X> internalComponentClass) Get client specific component instance.
<X> X	unwrapComposition(java.lang.Class<X> internalCompositionClass) Get the outmost external container of client specific component instance.
void	validate() Check validity by invoking validators on all components which support them.
boolean	validate(java.util.List<Component.Validatable> fields) Check validity by invoking validators on specified components which support them and show validation result notification.
boolean	validateAll() Check validity by invoking validators on all components which support them and show validation result notification.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.haulmont.cuba.gui.components.Component.OrderedContainer

getComponentNN

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Container

getComponentNN

Methods inherited from interface com.haulmont.cuba.gui.components.Component

setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Margin

setMargin, setMargin

Methods inherited from interface com.haulmont.cuba.gui.components.Component.ActionsHolder

getActionNN

Constructor Detail

AbstractFrame

public AbstractFrame()

Method Detail

setWrappedFrame

public void setWrappedFrame(Frame frame)

INTERNAL. Don't call from application code.

getWrappedFrame

public Frame getWrappedFrame()

Specified by:

getWrappedFrame in interface Frame.Wrapper

init

public void init(java.util.Map<java.lang.String,java.lang.Object> params)

Called by the framework after creation of all components and before showing the screen.
Override this method and put initialization logic here.

Parameters:

params - parameters passed from caller's code, usually from openWindow(String, com.haulmont.cuba.gui.WindowManager.OpenType) and similar methods, or set in screens.xml for this registered screen

getId

public java.lang.String getId()

Description copied from interface: Component

Component ID as defined in id attribute

Specified by:

getId in interface Component

setId

public void setId(java.lang.String id)

Description copied from interface: Component

Set component ID

Specified by:

setId in interface Component

getParent

public Component getParent()

Specified by:

getParent in interface Component

Returns:

Parent of component.

setParent

public void setParent(Component parent)

Description copied from interface: Component

INTERNAL.
Component.Container.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.

Specified by:

setParent in interface Component

Parameters:

parent - Parent component

getDebugId

public java.lang.String getDebugId()

Specified by:

getDebugId in interface Component

setDebugId

public void setDebugId(java.lang.String id)

Description copied from interface: Component

INTERNAL. Managed by debug Id system.

Specified by:

setDebugId in interface Component

isEnabled

public boolean isEnabled()

Description copied from interface: Component

Are the component and its parent enabled?

Specified by:

isEnabled in interface Component

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: Component

Set component enabled state

Specified by:

setEnabled in interface Component

isVisible

public boolean isVisible()

Description copied from interface: Component

Are the component and its parent visible?

Specified by:

isVisible in interface Component

setVisible

public void setVisible(boolean visible)

Description copied from interface: Component

Set component visibility

Specified by:

setVisible in interface Component

isVisibleItself

public boolean isVisibleItself()

Description copied from interface: Component

Is the component visible regardless of the parent?

Specified by:

isVisibleItself in interface Component

isEnabledItself

public boolean isEnabledItself()

Description copied from interface: Component

Is the component enabled regardless of the parent?

Specified by:

isEnabledItself in interface Component

requestFocus

public void requestFocus()

Description copied from interface: Component

Set focus to this component

Specified by:

requestFocus in interface Component

getHeight

public float getHeight()

Description copied from interface: Component

Get component height in Component.getHeightUnits()

Specified by:

getHeight in interface Component

getHeightUnits

public int getHeightUnits()

Description copied from interface: Component

Height units: Component.UNITS_PIXELS, Component.UNITS_PERCENTAGE

Specified by:

getHeightUnits in interface Component

setHeight

public void setHeight(java.lang.String height)

Description copied from interface: Component

Set component height in Component.getHeightUnits()

Specified by:

setHeight in interface Component

getWidth

public float getWidth()

Description copied from interface: Component

Get component width in Component.getWidthUnits()

Specified by:

getWidth in interface Component

getWidthUnits

public int getWidthUnits()

Description copied from interface: Component

Width units: Component.UNITS_PIXELS, Component.UNITS_PERCENTAGE

Specified by:

getWidthUnits in interface Component

setWidth

public void setWidth(java.lang.String width)

Description copied from interface: Component

Set component width in Component.getWidthUnits()

Specified by:

setWidth in interface Component

getAlignment

public Component.Alignment getAlignment()

Specified by:

getAlignment in interface Component

setAlignment

public void setAlignment(Component.Alignment alignment)

Specified by:

setAlignment in interface Component

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface Component.HasCaption

isResponsive

public boolean isResponsive()

Description copied from interface: Component

Is the component responsive?

Specified by:

isResponsive in interface Component

setResponsive

public void setResponsive(boolean responsive)

Description copied from interface: Component

Set component to be responsive by width and height. If responsive flag is true then you can use conditional CSS rules that respond to size changes in the browser. You can set specific rules using "width-range" or "height-range" properties in CSS files.

Specified by:

setResponsive in interface Component

setCaption

public void setCaption(java.lang.String caption)

Specified by:

setCaption in interface Component.HasCaption

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Component.HasCaption

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface Component.HasCaption

getIcon

public java.lang.String getIcon()

Description copied from interface: Component.HasIcon

Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

getIcon in interface Component.HasIcon

setIcon

public void setIcon(java.lang.String icon)

Description copied from interface: Component.HasIcon

Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

setIcon in interface Component.HasIcon

setIconFromSet

public void setIconFromSet(Icons.Icon icon)

Description copied from interface: Component.HasIcon

Set an icon from an icon set.

Specified by:

setIconFromSet in interface Component.HasIcon

add

public void add(Component component)

Specified by:

add in interface Component.Container

remove

public void remove(Component component)

Specified by:

remove in interface Component.Container

removeAll

public void removeAll()

Specified by:

removeAll in interface Component.Container

getOwnComponent

public Component getOwnComponent(java.lang.String id)

Description copied from interface: Component.Container

Get component directly owned by this container.

Specified by:

getOwnComponent in interface Component.Container

Returns:

component or null if not found

getComponent

@Nullable
public Component getComponent(java.lang.String id)

Description copied from interface: Component.Container

Get component belonging to the whole components tree below this container.

Specified by:

getComponent in interface Component.Container

Returns:

component or null if not found

getOwnComponents

public java.util.Collection<Component> getOwnComponents()

Description copied from interface: Component.Container

Get all components directly owned by this container

Specified by:

getOwnComponents in interface Component.Container

getComponents

public java.util.Collection<Component> getComponents()

Description copied from interface: Component.Container

Get all components belonging to the whole components tree below this container

Specified by:

getComponents in interface Component.Container

getComponent

public java.lang.Object getComponent()

Specified by:

getComponent in interface Component.Wrapper

getComposition

public java.lang.Object getComposition()

Specified by:

getComposition in interface Component.Wrapper

expand

public void expand(Component component,
                   java.lang.String height,
                   java.lang.String width)

Specified by:

expand in interface ExpandingLayout

expand

public void expand(Component component)

Specified by:

expand in interface ExpandingLayout

resetExpanded

public void resetExpanded()

Specified by:

resetExpanded in interface ExpandingLayout

isExpanded

public boolean isExpanded(Component component)

Specified by:

isExpanded in interface ExpandingLayout

getExpandDirection

public ExpandingLayout.ExpandDirection getExpandDirection()

Specified by:

getExpandDirection in interface ExpandingLayout

getContext

public FrameContext getContext()

Specified by:

getContext in interface Frame

Returns:

current frame context

setContext

public void setContext(FrameContext ctx)

Description copied from interface: Frame

INTERNAL. Don't call from application code.

Specified by:

setContext in interface Frame

getDsContext

public DsContext getDsContext()

Specified by:

getDsContext in interface Frame

Returns:

DsContext of the current frame or window

setDsContext

public void setDsContext(DsContext dsContext)

Description copied from interface: Frame

INTERNAL. Don't call from application code.

Specified by:

setDsContext in interface Frame

getMessagesPack

public java.lang.String getMessagesPack()

Specified by:

getMessagesPack in interface Frame

Returns:

the message pack associated with the frame, usually in XML descriptor

setMessagesPack

public void setMessagesPack(java.lang.String name)

Description copied from interface: Frame

Set message pack for this frame.

Specified by:

setMessagesPack in interface Frame

Parameters:

name - message pack name

registerComponent

public void registerComponent(Component component)

Description copied from interface: Frame

INTERNAL. Don't call from application code.

Specified by:

registerComponent in interface Frame

unregisterComponent

public void unregisterComponent(Component component)

Description copied from interface: Frame

INTERNAL. Don't call from application code.

Specified by:

unregisterComponent in interface Frame

getRegisteredComponent

@Nullable
public Component getRegisteredComponent(java.lang.String id)

Description copied from interface: Frame

INTERNAL. Don't call from application code.

Specified by:

getRegisteredComponent in interface Frame

isValid

public boolean isValid()

Description copied from interface: Frame

Check validity by invoking validators on all components which support them.

Specified by:

isValid in interface Frame

Returns:

true if all components are in valid state

validate

public void validate()
              throws ValidationException

Description copied from interface: Frame

Check validity by invoking validators on all components which support them.

Specified by:

validate in interface Frame

Throws:

ValidationException - if some components are currently in invalid state

validate

public boolean validate(java.util.List<Component.Validatable> fields)

Description copied from interface: Frame

Check validity by invoking validators on specified components which support them and show validation result notification.

Specified by:

validate in interface Frame

Returns:

true if the validation was successful, false if there were any problems

validateAll

public boolean validateAll()

Description copied from interface: Frame

Check validity by invoking validators on all components which support them and show validation result notification.

Specified by:

validateAll in interface Frame

Returns:

true if the validation was successful, false if there were any problems

showValidationErrors

public void showValidationErrors(ValidationErrors errors)

Show validation errors alert. Can be overriden in subclasses.

Parameters:

errors - the list of validation errors. Caller fills it by errors found during the default validation.

getDialogParams

@Deprecated
public DialogParams getDialogParams()

Deprecated. Use WindowManager.OpenType or Window.getDialogOptions() from screen controller

Specified by:

getDialogParams in interface Frame

Returns:

DialogParams that will be used for opening next window in modal mode.
If called in init() method of a screen, which is being opened in WindowManager.OpenType#DIALOG mode, affects the current screen itself.

add

public void add(Component childComponent,
                int index)

Specified by:

add in interface Component.OrderedContainer

indexOf

public int indexOf(Component component)

Specified by:

indexOf in interface Component.OrderedContainer

getComponent

@Nullable
public Component getComponent(int index)

Description copied from interface: Component.OrderedContainer

Returns the component at the given position.

Specified by:

getComponent in interface Component.OrderedContainer

Parameters:

index - component index

Returns:

the component at the given index or null.

getCompanion

@Nullable
public <T> T getCompanion()

Returns:

a companion implementation, specific for the current client type

setCompanion

public void setCompanion(java.lang.Object companion)

INTERNAL. Don't call from application code.

getUiEventListeners

@Nullable
public java.util.List<org.springframework.context.ApplicationListener> getUiEventListeners()

INTERNAL. Don't call from application code.

setUiEventListeners

public void setUiEventListeners(java.util.List<org.springframework.context.ApplicationListener> uiEventListeners)

INTERNAL. Don't call from application code.

openWindow

public AbstractWindow openWindow(java.lang.String windowAlias,
                                 WindowManager.OpenType openType,
                                 java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: Frame

Open a simple screen.

Specified by:

openWindow in interface Frame

Parameters:

windowAlias - screen ID as defined in screens.xml

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

Returns:

created window

openWindow

public AbstractWindow openWindow(java.lang.String windowAlias,
                                 WindowManager.OpenType openType)

Description copied from interface: Frame

Open a simple screen.

Specified by:

openWindow in interface Frame

Parameters:

windowAlias - screen ID as defined in screens.xml

openType - how to open the screen

Returns:

created window

openEditor

public AbstractEditor openEditor(Entity item,
                                 WindowManager.OpenType openType)

Description copied from interface: Frame

Open an edit screen for entity instance.

Specified by:

openEditor in interface Frame

Parameters:

item - entity to edit

openType - how to open the screen

Returns:

created window

openEditor

public AbstractEditor openEditor(Entity item,
                                 WindowManager.OpenType openType,
                                 java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: Frame

Open an edit screen for entity instance.

Specified by:

openEditor in interface Frame

Parameters:

item - entity to edit

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

Returns:

created window

openEditor

public AbstractEditor openEditor(Entity item,
                                 WindowManager.OpenType openType,
                                 java.util.Map<java.lang.String,java.lang.Object> params,
                                 Datasource parentDs)

Description copied from interface: Frame

Open an edit screen for entity instance.

Specified by:

openEditor in interface Frame

Parameters:

item - entity to edit

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

parentDs - if this parameter is not null, the editor will commit edited instance into this datasource instead of directly to database

Returns:

created window

openEditor

public AbstractEditor openEditor(java.lang.String windowAlias,
                                 Entity item,
                                 WindowManager.OpenType openType,
                                 java.util.Map<java.lang.String,java.lang.Object> params,
                                 Datasource parentDs)

Description copied from interface: Frame

Open an edit screen.

Specified by:

openEditor in interface Frame

Parameters:

windowAlias - screen ID as defined in screens.xml

item - entity to edit

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

parentDs - if this parameter is not null, the editor will commit edited instance into this datasource instead of directly to database

Returns:

created window

openEditor

public AbstractEditor openEditor(java.lang.String windowAlias,
                                 Entity item,
                                 WindowManager.OpenType openType,
                                 java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: Frame

Open an edit screen.

Specified by:

openEditor in interface Frame

Parameters:

windowAlias - screen ID as defined in screens.xml

item - entity to edit

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

Returns:

created window

openEditor

public AbstractEditor openEditor(java.lang.String windowAlias,
                                 Entity item,
                                 WindowManager.OpenType openType,
                                 Datasource parentDs)

Description copied from interface: Frame

Open an edit screen.

Specified by:

openEditor in interface Frame

Parameters:

windowAlias - screen ID as defined in screens.xml

item - entity to edit

openType - how to open the screen

parentDs - if this parameter is not null, the editor will commit edited instance into this datasource instead of directly to database

Returns:

created window

openEditor

public AbstractEditor openEditor(java.lang.String windowAlias,
                                 Entity item,
                                 WindowManager.OpenType openType)

Description copied from interface: Frame

Open an edit screen.

Specified by:

openEditor in interface Frame

Parameters:

windowAlias - screen ID as defined in screens.xml

item - entity to edit

openType - how to open the screen

Returns:

created window

openLookup

public AbstractLookup openLookup(java.lang.Class<? extends Entity> entityClass,
                                 Window.Lookup.Handler handler,
                                 WindowManager.OpenType openType)

Description copied from interface: Frame

Open a lookup screen.

Specified by:

openLookup in interface Frame

Parameters:

entityClass - required class of entity

handler - is invoked when selection confirmed and the lookup screen closes

openType - how to open the screen

Returns:

created window

openLookup

public AbstractLookup openLookup(java.lang.Class<? extends Entity> entityClass,
                                 Window.Lookup.Handler handler,
                                 WindowManager.OpenType openType,
                                 java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: Frame

Open a lookup screen.

Specified by:

openLookup in interface Frame

Parameters:

entityClass - required class of entity

handler - is invoked when selection confirmed and the lookup screen closes

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

Returns:

created window

openLookup

public AbstractLookup openLookup(java.lang.String windowAlias,
                                 Window.Lookup.Handler handler,
                                 WindowManager.OpenType openType,
                                 java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: Frame

Open a lookup screen.

Specified by:

openLookup in interface Frame

Parameters:

windowAlias - screen ID as defined in screens.xml

handler - is invoked when selection confirmed and the lookup screen closes

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

Returns:

created window

openLookup

public AbstractLookup openLookup(java.lang.String windowAlias,
                                 Window.Lookup.Handler handler,
                                 WindowManager.OpenType openType)

Description copied from interface: Frame

Open a lookup screen.

Specified by:

openLookup in interface Frame

Parameters:

windowAlias - screen ID as defined in screens.xml

handler - is invoked when selection confirmed and the lookup screen closes

openType - how to open the screen

Returns:

created window

openFrame

public AbstractFrame openFrame(@Nullable
                               Component parent,
                               java.lang.String windowAlias)

Load a frame registered in screens.xml and optionally show it inside a parent component of this frame.

Specified by:

openFrame in interface Frame

Parameters:

parent - if specified, all parent's subcomponents will be removed and the frame will be added

windowAlias - frame ID as defined in screens.xml

Returns:

frame's controller instance

openFrame

public AbstractFrame openFrame(@Nullable
                               Component parent,
                               java.lang.String windowAlias,
                               java.util.Map<java.lang.String,java.lang.Object> params)

Load a frame registered in screens.xml and optionally show it inside a parent component of this frame.

Specified by:

openFrame in interface Frame

Parameters:

parent - if specified, all parent's subcomponents will be removed and the frame will be added

windowAlias - frame ID as defined in screens.xml

params - parameters to be passed into the frame's controller init method

Returns:

frame's controller instance

showMessageDialog

public void showMessageDialog(java.lang.String title,
                              java.lang.String message,
                              Frame.MessageType messageType)

Description copied from interface: Frame

Show message dialog with title and message.
Message supports line breaks (\n).

Specified by:

showMessageDialog in interface Frame

Parameters:

title - dialog title

message - text

messageType - defines how to display the dialog. Don't forget to escape data from the database in case of *_HTML types!

showOptionDialog

public void showOptionDialog(java.lang.String title,
                             java.lang.String message,
                             Frame.MessageType messageType,
                             Action[] actions)

Description copied from interface: Frame

Show options dialog with title and message.
Message supports line breaks (\n).

Specified by:

showOptionDialog in interface Frame

Parameters:

title - dialog title

message - text

messageType - defines how to display the dialog. Don't forget to escape data from the database in case of *_HTML types!

actions - array of actions that represent options. For standard options consider use of DialogAction instances.

showOptionDialog

public void showOptionDialog(java.lang.String title,
                             java.lang.String message,
                             Frame.MessageType messageType,
                             java.util.List<Action> actions)

Description copied from interface: Frame

Show options dialog with title and message.
Message supports line breaks (\n).

Specified by:

showOptionDialog in interface Frame

Parameters:

title - dialog title

message - text

messageType - defines how to display the dialog. Don't forget to escape data from the database in case of *_HTML types!

actions - list of actions that represent options. For standard options consider use of DialogAction instances.

showNotification

public void showNotification(java.lang.String caption)

Description copied from interface: Frame

Show notification with Frame.NotificationType.HUMANIZED.
Supports line breaks (\n).

Specified by:

showNotification in interface Frame

Parameters:

caption - notification text

showNotification

public void showNotification(java.lang.String caption,
                             Frame.NotificationType type)

Description copied from interface: Frame

Show notification.
Supports line breaks (\n) for non HTML type.

Specified by:

showNotification in interface Frame

Parameters:

caption - notification text

type - defines how to display the notification. Don't forget to escape data from the database in case of *_HTML types!

showNotification

public void showNotification(java.lang.String caption,
                             java.lang.String description,
                             Frame.NotificationType type)

Description copied from interface: Frame

Show notification with caption and description.
Supports line breaks (\n) for non HTML type.

Specified by:

showNotification in interface Frame

Parameters:

caption - notification text

description - notification description

type - defines how to display the notification. Don't forget to escape data from the database in case of *_HTML types!

showWebPage

public void showWebPage(java.lang.String url,
                        @Nullable
                        java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: Frame

Open a web page in browser.

Specified by:

showWebPage in interface Frame

Parameters:

url - URL of the page

params - optional parameters.
The following parameters are recognized by Web client: - target - String value used as the target name in a window.open call in the client. This means that special values such as "_blank", "_self", "_top", "_parent" have special meaning. If not specified, "_blank" is used.
- width - Integer value specifying the width of the browser window in pixels
- height - Integer value specifying the height of the browser window in pixels
- border - String value specifying the border style of the window of the browser window. Possible values are "DEFAULT", "MINIMAL", "NONE".

Desktop client doesn't support any parameters and just ignores them.

getFrame

public Frame getFrame()

Specified by:

getFrame in interface Component.BelongToFrame

setFrame

public void setFrame(Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

getStyleName

public java.lang.String getStyleName()

Description copied from interface: Component

Styles implementation is client-type-specific.

Specified by:

getStyleName in interface Component

Returns:

current style name.

setStyleName

public void setStyleName(java.lang.String styleName)

Description copied from interface: Component

Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.

Specified by:

setStyleName in interface Component

Parameters:

styleName - one or more style names separated by space.

addStyleName

public void addStyleName(java.lang.String styleName)

Description copied from interface: Component

Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names.

Specified by:

addStyleName in interface Component

Parameters:

styleName - one or more style names separated by space.

removeStyleName

public void removeStyleName(java.lang.String styleName)

Description copied from interface: Component

Removes one or more style names from component. Multiple styles can be specified as a space-separated list of style names.

Specified by:

removeStyleName in interface Component

Parameters:

styleName - one or more style names separated by space.

unwrap

public <X> X unwrap(java.lang.Class<X> internalComponentClass)

Description copied from interface: Component

Get client specific component instance. Can be used in client module to simplify invocation of underlying API.
Example:

 com.vaadin.ui.TextField vTextField = textField.unwrap(com.vaadin.ui.TextField.class);
 

Specified by:

unwrap in interface Component

Type Parameters:

X - type of internal class

Parameters:

internalComponentClass - class of underlying component implementation based on Vaadin or Swing

Returns:

internal client specific component

unwrapComposition

public <X> X unwrapComposition(java.lang.Class<X> internalCompositionClass)

Description copied from interface: Component

Get the outmost external container of client specific component instance. Can be used in client module to simplify invocation of underlying API.
Example:

 com.vaadin.ui.Layout vLayout = table.unwrapComposition(com.vaadin.ui.Layout.class);
 

Specified by:

unwrapComposition in interface Component

Type Parameters:

X - type of internal class

Parameters:

internalCompositionClass - class of underlying composition implementation based on Vaadin or Swing

Returns:

internal client specific component

setSpacing

public void setSpacing(boolean enabled)

Specified by:

setSpacing in interface Component.Spacing

getSpacing

public boolean getSpacing()

Specified by:

getSpacing in interface Component.Spacing

setMargin

public void setMargin(MarginInfo marginInfo)

Specified by:

setMargin in interface Component.Margin

getMargin

public MarginInfo getMargin()

Specified by:

getMargin in interface Component.Margin

addAction

public void addAction(Action action)

Description copied from interface: Component.ActionsHolder

Add an action to the component

Specified by:

addAction in interface Component.ActionsHolder

addAction

public void addAction(Action action,
                      int index)

Description copied from interface: Component.ActionsHolder

Add an action to the component with index.

Specified by:

addAction in interface Component.ActionsHolder

removeAction

public void removeAction(@Nullable
                         Action action)

Description copied from interface: Component.ActionsHolder

Remove the action from the component

Specified by:

removeAction in interface Component.ActionsHolder

removeAction

public void removeAction(@Nullable
                         java.lang.String id)

Description copied from interface: Component.ActionsHolder

Remove the action by its ID. If there is no action with that ID, nothing happens.

Specified by:

removeAction in interface Component.ActionsHolder

removeAllActions

public void removeAllActions()

Description copied from interface: Component.ActionsHolder

Remove all actions from the component

Specified by:

removeAllActions in interface Component.ActionsHolder

getActions

public java.util.Collection<Action> getActions()

Specified by:

getActions in interface Component.ActionsHolder

Returns:

unmodifiable collection of actions

getAction

@Nullable
public Action getAction(java.lang.String id)

Specified by:

getAction in interface Component.ActionsHolder

Returns:

an action by its ID, or null if not found