com.sibvisions.apps.profile

Class ProfileSetup

java.lang.Object

com.sibvisions.apps.profile.ProfileSetup

All Implemented Interfaces:

com.sibvisions.apps.projx.event.type.app.IAfterOpenWorkScreenListener, com.sibvisions.apps.projx.event.type.app.IBeforeCloseWorkScreenListener, ICloseable, IApplicationSetup

public class ProfileSetup
extends Object
implements IApplicationSetup, com.sibvisions.apps.projx.event.type.app.IAfterOpenWorkScreenListener, com.sibvisions.apps.projx.event.type.app.IBeforeCloseWorkScreenListener, ICloseable

The ProfileSetup handles loading and saving of profiles.

Constructor Summary

Constructors

Constructor and Description
ProfileSetup() Constructs a new ProfileSetup.

Method Summary

Modifier and Type	Method and Description
void	afterOpenWorkScreen(com.sibvisions.apps.projx.event.type.app.WorkScreenEvent pEvent) Invoked after a work-screen was opened.
void	apply(IApplication pApplication)
void	beforeCloseWorkScreen(com.sibvisions.apps.projx.event.type.app.WorkScreenEvent pEvent) Invoked before a work-screen was closed.
void	close()
void	debug(Object... pInfo) Logs debug information.
void	getAllComponentProfiles(IComponent pComponent, XmlNode pXmlProfile, List<IComponentProfile> pComponentProfiles) Gets the profile for the given component and all its subcomponents.
String	getComponentKey(IComponent pComponent) Gets a reproducible name of the component.
protected void	getComponentProfile(IComponent pComponent, XmlNode pXmlProfile, List<IComponentProfile> pComponentProfiles) Gets the profile for the given component.
XmlNode	getWorkScreenProfile(com.sibvisions.apps.projx.ProjX pApplication, IWorkScreen pWorkScreen) Gets the profile for a given work screen.
void	setAllComponentProfiles(IComponent pComponent, HashMap<String,XmlNode> pXmlProfile, List<IComponentProfile> pComponentProfiles) Set the profile for the given component and all its subcomponents.
void	setComponentProfile(IComponent pComponent, HashMap<String,XmlNode> pXmlProfile, List<IComponentProfile> pComponentProfiles) Set the profile for a given component.
void	setWorkScreenProfile(com.sibvisions.apps.projx.ProjX pApplication, IWorkScreen pWorkScreen, XmlNode pWorkScreenProfile) Sets the work screen profile for the given work screen.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileSetup

public ProfileSetup()

Constructs a new ProfileSetup.

Method Detail

apply

public void apply(IApplication pApplication)

Specified by:

apply in interface IApplicationSetup

close

public void close()

Specified by:

close in interface ICloseable

getComponentKey

public String getComponentKey(IComponent pComponent)

Gets a reproducible name of the component.

Parameters:

pComponent - the component

Returns:

the name

setWorkScreenProfile

public void setWorkScreenProfile(com.sibvisions.apps.projx.ProjX pApplication,
                                 IWorkScreen pWorkScreen,
                                 XmlNode pWorkScreenProfile)

Sets the work screen profile for the given work screen.

Parameters:

pApplication - the application

pWorkScreen - the work screen

pWorkScreenProfile - the profile

setComponentProfile

public void setComponentProfile(IComponent pComponent,
                                HashMap<String,XmlNode> pXmlProfile,
                                List<IComponentProfile> pComponentProfiles)

Set the profile for a given component.

Parameters:

pComponent - the component

pXmlProfile - the profile

pComponentProfiles - the IComponentProfile implementations.

setAllComponentProfiles

public void setAllComponentProfiles(IComponent pComponent,
                                    HashMap<String,XmlNode> pXmlProfile,
                                    List<IComponentProfile> pComponentProfiles)

Set the profile for the given component and all its subcomponents.

Parameters:

pComponent - the component

pXmlProfile - the profile

pComponentProfiles - the IComponentProfile implementations.

getWorkScreenProfile

public XmlNode getWorkScreenProfile(com.sibvisions.apps.projx.ProjX pApplication,
                                    IWorkScreen pWorkScreen)

Gets the profile for a given work screen.

Parameters:

pApplication - the application.

pWorkScreen - the work screen

Returns:

the profile.

getComponentProfile

protected void getComponentProfile(IComponent pComponent,
                                   XmlNode pXmlProfile,
                                   List<IComponentProfile> pComponentProfiles)

Gets the profile for the given component.

Parameters:

pComponent - the component

pXmlProfile - the profile to fill in.

pComponentProfiles - the IComponentProfile implementations.

getAllComponentProfiles

public void getAllComponentProfiles(IComponent pComponent,
                                    XmlNode pXmlProfile,
                                    List<IComponentProfile> pComponentProfiles)

Gets the profile for the given component and all its subcomponents.

Parameters:

pComponent - the component

pXmlProfile - the profile to fill in.

pComponentProfiles - the IComponentProfile implementations.

debug

public final void debug(Object... pInfo)

Logs debug information.

Parameters:

pInfo - the debug information

afterOpenWorkScreen

public void afterOpenWorkScreen(com.sibvisions.apps.projx.event.type.app.WorkScreenEvent pEvent)

Invoked after a work-screen was opened.

Specified by:

afterOpenWorkScreen in interface com.sibvisions.apps.projx.event.type.app.IAfterOpenWorkScreenListener

Parameters:

pEvent - the screen event

beforeCloseWorkScreen

public void beforeCloseWorkScreen(com.sibvisions.apps.projx.event.type.app.WorkScreenEvent pEvent)
                           throws Throwable

Invoked before a work-screen was closed.

Specified by:

beforeCloseWorkScreen in interface com.sibvisions.apps.projx.event.type.app.IBeforeCloseWorkScreenListener

Parameters:

pEvent - the screen event

Throws:

Throwable - if saving profile fails