com.sibvisions.apps.profile

Class ProfileUtil

java.lang.Object

com.sibvisions.apps.profile.ProfileUtil

public final class ProfileUtil
extends Object

The ProfileUtil allows simple customization of profile behaviour.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLY_SORT_ON_DATABOOK The constant for showing the table information button.
static String	COMPONENT_PROFILE_ENABLED The constant for storing component profile enabled state.
static String	DESIGN_TIME The constant for storing design time information.
static String	IGNORE_COMPONENT_PROFILE The constant for storing ignore component profile state.
static String	SHOW_TABLE_INFORMATION_BUTTON The constant for showing the table information button.
static String	TABLE_INFORMATION_DIALOG_CLASS The constant for storing table information dialog class.

Method Summary

Modifier and Type	Method and Description
static void	addComponentProfile(IApplication pApplication, IComponentProfile pComponentProfile) Adds an additional component profile for the given application.
static List<IComponentProfile>	getAllComponentProfiles(IWorkScreen pWorkScreen) Gets the list of available IComponentProfile implementations for the given work screen.
static List<IComponentProfile>	getComponentProfiles(IApplication pApplication) Gets the list of custom IComponentProfile.
static Class<TableInformationDialog>	getDefaultTableInformationDialogClass(IApplication pApplication) Gets the default TableInformationDialog class for the given application.
static Class<TableInformationDialog>	getTableInformationDialogClass(com.sibvisions.apps.components.NavigationTable pNavigationTable) Gets the TableInformationDialog class for the given NavigationTable.
static boolean	isApplySortOnDataBook(UITable pTable) Gets if sort should be applied on data books.
static boolean	isDefaultApplySortOnDataBook(IApplication pApplication) Gets if sort should be applied on data books by default.
static boolean	isDefaultShowTableInformationButton(IApplication pApplication) Gets if default TableInformation button should be shown.
static boolean	isDesignTime(IComponent pComponent) Gets design time information on component.
static boolean	isIgnoreProfile(IComponent pComponent) Gets, if the profile for the component and all its children should be ignored.
static boolean	isProfileEnabled(IComponent pComponent) Gets, if profile for the specific component enabled or disabled.
static boolean	isShowTableInformationButton(com.sibvisions.apps.components.NavigationTable pNavigationTable) Gets if TableInformation button should be shown.
static void	removeComponentProfile(IApplication pApplication, IComponentProfile pComponentProfile) Adds an additional component profile for the given application.
static void	setApplySortOnDataBook(UITable pTable, boolean pApplySortOnDataBook) Sets if sort should be applied on data books.
static void	setDefaultApplySortOnDataBook(IApplication pApplication, boolean pApplySortOnDataBook) Sets if sort should be applied on data books by default.
static void	setDefaultShowTableInformationButton(IApplication pApplication, boolean pShowTableInformationButton) Sets if default TableInformation button should be shown.
static void	setDefaultTableInformationDialogClass(IApplication pApplication, Class<TableInformationDialog> pTableInformationDialogClass) Sets the default TableInformationDialog class for the given application.
static void	setDesignTime(IComponent pComponent, boolean pDesignTime) Sets design time information on component.
static void	setIgnoreProfile(IComponent pComponent, boolean pIgnore) Sets, if the profile for the component and all its children should be ignored.
static void	setProfileEnabled(IComponent pComponent, boolean pEnabled) Sets profile for the specific component enabled or disabled.
static void	setShowTableInformationButton(com.sibvisions.apps.components.NavigationTable pNavigationTable, boolean pShowTableInformationButton) Sets if TableInformation button should be shown.
static void	setTableInformationDialogClass(com.sibvisions.apps.components.NavigationTable pNavigationTable, Class<TableInformationDialog> pTableInformationDialogClass) Sets the TableInformationDialog class for the given NavigationTable.

Methods inherited from class java.lang.Object

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

Field Detail

DESIGN_TIME

public static final String DESIGN_TIME

The constant for storing design time information.

See Also:

Constant Field Values

COMPONENT_PROFILE_ENABLED

public static final String COMPONENT_PROFILE_ENABLED

The constant for storing component profile enabled state.

See Also:

Constant Field Values

IGNORE_COMPONENT_PROFILE

public static final String IGNORE_COMPONENT_PROFILE

The constant for storing ignore component profile state.

See Also:

Constant Field Values

TABLE_INFORMATION_DIALOG_CLASS

public static final String TABLE_INFORMATION_DIALOG_CLASS

The constant for storing table information dialog class.

See Also:

Constant Field Values

SHOW_TABLE_INFORMATION_BUTTON

public static final String SHOW_TABLE_INFORMATION_BUTTON

The constant for showing the table information button.

See Also:

Constant Field Values

APPLY_SORT_ON_DATABOOK

public static final String APPLY_SORT_ON_DATABOOK

The constant for showing the table information button.

See Also:

Constant Field Values

Method Detail

getAllComponentProfiles

public static List<IComponentProfile> getAllComponentProfiles(IWorkScreen pWorkScreen)

Gets the list of available IComponentProfile implementations for the given work screen.

Parameters:

pWorkScreen - the work screen

Returns:

the list of available IComponentProfile implementations

addComponentProfile

public static void addComponentProfile(IApplication pApplication,
                                       IComponentProfile pComponentProfile)

Adds an additional component profile for the given application.

Parameters:

pApplication - the application

pComponentProfile - the IComponentProfile

removeComponentProfile

public static void removeComponentProfile(IApplication pApplication,
                                          IComponentProfile pComponentProfile)

Adds an additional component profile for the given application.

Parameters:

pApplication - the application

pComponentProfile - the IComponentProfile

getComponentProfiles

public static List<IComponentProfile> getComponentProfiles(IApplication pApplication)

Gets the list of custom IComponentProfile.

Parameters:

pApplication - the work screen

Returns:

the list of custom IComponentProfile.

setProfileEnabled

public static void setProfileEnabled(IComponent pComponent,
                                     boolean pEnabled)

Sets profile for the specific component enabled or disabled. By default a component is enabled.

Parameters:

pComponent - the component.

pEnabled - true for enabled, false for disabled.

isProfileEnabled

public static boolean isProfileEnabled(IComponent pComponent)

Gets, if profile for the specific component enabled or disabled. By default a component is enabled.

Parameters:

pComponent - the component.

Returns:

true for enabled, false for disabled.

setIgnoreProfile

public static void setIgnoreProfile(IComponent pComponent,
                                    boolean pIgnore)

Sets, if the profile for the component and all its children should be ignored. By default the profile is not ignored.

Parameters:

pComponent - the component.

pIgnore - true, if profile for the component and all its children should be ignored.

isIgnoreProfile

public static boolean isIgnoreProfile(IComponent pComponent)

Gets, if the profile for the component and all its children should be ignored. By default the profile is not ignored.

Parameters:

pComponent - the component.

Returns:

true, if profile for the component and all its children should be ignored.

setDesignTime

public static void setDesignTime(IComponent pComponent,
                                 boolean pDesignTime)

Sets design time information on component.

Parameters:

pComponent - the component.

pDesignTime - design time information on component.

isDesignTime

public static boolean isDesignTime(IComponent pComponent)

Gets design time information on component.

Parameters:

pComponent - the component.

Returns:

design time information on component.

getTableInformationDialogClass

public static Class<TableInformationDialog> getTableInformationDialogClass(com.sibvisions.apps.components.NavigationTable pNavigationTable)

Gets the TableInformationDialog class for the given NavigationTable.

Parameters:

pNavigationTable - the NavigationTable

Returns:

the TableInformationDialog class

setTableInformationDialogClass

public static void setTableInformationDialogClass(com.sibvisions.apps.components.NavigationTable pNavigationTable,
                                                  Class<TableInformationDialog> pTableInformationDialogClass)

Sets the TableInformationDialog class for the given NavigationTable.

Parameters:

pNavigationTable - the NavigationTable

pTableInformationDialogClass - the TableInformationDialog class

getDefaultTableInformationDialogClass

public static Class<TableInformationDialog> getDefaultTableInformationDialogClass(IApplication pApplication)

Gets the default TableInformationDialog class for the given application.

Parameters:

pApplication - the application

Returns:

the TableInformationDialog class

setDefaultTableInformationDialogClass

public static void setDefaultTableInformationDialogClass(IApplication pApplication,
                                                         Class<TableInformationDialog> pTableInformationDialogClass)

Sets the default TableInformationDialog class for the given application.

Parameters:

pApplication - the application

pTableInformationDialogClass - the TableInformationDialog class

isShowTableInformationButton

public static boolean isShowTableInformationButton(com.sibvisions.apps.components.NavigationTable pNavigationTable)

Gets if TableInformation button should be shown.

Parameters:

pNavigationTable - the NavigationTable

Returns:

if TableInformation button should be shown.

setShowTableInformationButton

public static void setShowTableInformationButton(com.sibvisions.apps.components.NavigationTable pNavigationTable,
                                                 boolean pShowTableInformationButton)

Sets if TableInformation button should be shown.

Parameters:

pNavigationTable - the NavigationTable

pShowTableInformationButton - if TableInformation button should be shown.

isDefaultShowTableInformationButton

public static boolean isDefaultShowTableInformationButton(IApplication pApplication)

Gets if default TableInformation button should be shown.

Parameters:

pApplication - the application

Returns:

if default TableInformation button should be shown.

setDefaultShowTableInformationButton

public static void setDefaultShowTableInformationButton(IApplication pApplication,
                                                        boolean pShowTableInformationButton)

Sets if default TableInformation button should be shown.

Parameters:

pApplication - the application

pShowTableInformationButton - if default TableInformation button should be shown.

isApplySortOnDataBook

public static boolean isApplySortOnDataBook(UITable pTable)

Gets if sort should be applied on data books.

Parameters:

pTable - the NavigationTable

Returns:

if sort should be applied on data books.

setApplySortOnDataBook

public static void setApplySortOnDataBook(UITable pTable,
                                          boolean pApplySortOnDataBook)

Sets if sort should be applied on data books.

Parameters:

pTable - the NavigationTable

pApplySortOnDataBook - if sort should be applied on data books.

isDefaultApplySortOnDataBook

public static boolean isDefaultApplySortOnDataBook(IApplication pApplication)

Gets if sort should be applied on data books by default.

Parameters:

pApplication - the application

Returns:

if sort should be applied on data books by default.

setDefaultApplySortOnDataBook

public static void setDefaultApplySortOnDataBook(IApplication pApplication,
                                                 boolean pApplySortOnDataBook)

Sets if sort should be applied on data books by default.

Parameters:

pApplication - the application

pApplySortOnDataBook - if sort should be applied on data books by default.