|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.control.LyController
leon.control.LyAreaController
leon.control.LyMultiAreaController
leon.control.LyDashboardController
public class LyDashboardController
This class implements a dashboard view, usually associated to a '_dashboard' action in the meta-model.
A Dashboard view is a 'toolbar' view which contains a set of other actions, or sub-dashboard views (popup dashboards).
The user may activate an action from the dashboard by a click on any button of this view. Further click on the same action may either re-open existing window or create a new one if former windows was freed :
for additional information.
Additionally, the view supports image buttons, with or without labels and a small tooltip
info on actions. Current implementation uses a LyDashboardBehaviorInterface (usually
implemented by a LyDashboardBehavior) and uses a LyDashboardBuilder to create and set view
content.
,
LyDashboardBehavior
,
LyDashboardBehaviorInterface
,
LyDashboardBuilder
Field Summary | |
---|---|
static java.lang.String |
__VERSION
File version |
static java.lang.String |
DEMAND_CLOSE_ALL
Identifier for modifying filter. |
static java.lang.String |
DEMAND_SEARCH
Identifier for search tool. |
static java.lang.String |
SEARCH_CLASS
Identifier for search class. |
static int |
SEARCH_LIMIT
Search limit. |
static java.lang.String |
SEARCH_VALUE
Identifier for search value. |
static java.lang.String |
TAB_ID_PREFIX
Internal prefix for tab identifiers. |
Fields inherited from class leon.control.LyAreaController |
---|
DEFAULT_MENU_ITEM_IMAGE_SIZE, DEMAND_APPLY, DEMAND_CANCEL, DEMAND_CLOSE, DEMAND_CREATE_CHART, DEMAND_DELETE_CHART, DEMAND_DELETE_OBJECTINFOS, DEMAND_DELETE_PREFERENCE, DEMAND_UPDATE_VIEW, DEMAND_VALIDATE |
Fields inherited from class leon.control.LyController |
---|
_nbControllers, _nextId, CONTROLLER_ID_SEP, DEFAULT_IMAGE_FORMAT, DEMAND_HELP, ID_SEP |
Constructor Summary | |
---|---|
LyDashboardController(LySession session,
LyController parent,
LyAction action,
LyClassInfo classInfo,
LyObjectList objects)
Constructor. |
Method Summary | |
---|---|
void |
actionDemand(LyActionDemand demand)
Invoked when an action occurs. |
void |
addViewController(java.lang.String id,
LyViewController controller)
Add a view controller to keep. |
void |
closeAllViews()
Closes all the views displayed in the dashboard. |
void |
closeCurrentView(boolean closeTabs)
Close view currently being displayed in the dashboard view (single view mode only). |
void |
free(LyController controller)
Free this controller. |
LyInfoList<LyAction> |
getActions()
Accessor to the list of actions shown in the view. |
java.lang.Class<?> |
getBehaviorInterface()
Method that gives the interface that must be implemented by the behavior associated to this controller. |
LyAreaController |
getDisplayedAreaController()
Accessor to the area controller displayed in the dashboard. |
java.lang.String |
getHelpFile()
Gets help file associated with this controller. |
java.lang.String |
getImage()
Gets image associated with this controller. |
LyInfoList<LyAction> |
getOpenedActions()
Accessor to the list of actions opened in the dashboard. |
LyAction |
getSocialAction()
Fetch the social action. |
LyArea |
getTargetArea(LyAction action)
Gets the target area : the panel where the action will be shown. |
java.lang.String |
getTitle()
Gets title associated with this controller. |
java.util.Hashtable<java.lang.String,LyViewController> |
getViewControllers()
Return the list of view controllers opened from this controller. |
boolean |
isViewResizable()
Indicates if the view for this dashboard controller is resizable. |
void |
reset(boolean full)
Reset the entire view : everything is rebuilt. |
void |
selectionDemand(LySelectionDemand demand)
Invoked when an selection notification is sent to this listener. |
void |
setAction(LyAction action)
Change the main action for this controller. |
void |
setAction(LyAction action,
boolean deleteOnClose)
Change the main action for this controller. |
void |
setEnabled(LyAction action,
boolean enable)
Enables/Disables given objectInfo representation in the dashboard view. |
void |
setImage(LyAction action,
java.lang.String image)
Updates the action image representation in the controlled dashboard . |
void |
updateViewFromValues(LyDemand demand)
Update the view of the controller with the specified values from the demand (internal use) . |
void |
updateWindowMenu()
Updates the Window menu of the menu bar. |
boolean |
useSingleView()
Indicates whether the actions opened from this dashboard must be opened in a new view or not. |
boolean |
useTabs()
Indicates whether the actions opened from this dashboard must be opened in tabs. |
Methods inherited from class leon.control.LyController |
---|
activateViewDemand, demandPerformed, dragDropDemand, getApplication, getClassInfo, getComponent, getId, getImage, getImage, getImage, getImage, getImageFromPrefix, getImageFromPrefix, getImageFromPrefix, getName, getObjectId, getSession, getUserData, getView, getViewManager, helpDemand, hideView, isFreed, isIdle, setBuilder, setBuilderClass, setLastModified, setName, setUserData, showError, showError, showWarning |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String __VERSION
public static final java.lang.String DEMAND_CLOSE_ALL
public static final java.lang.String DEMAND_SEARCH
public static final java.lang.String TAB_ID_PREFIX
public static final java.lang.String SEARCH_CLASS
public static final java.lang.String SEARCH_VALUE
public static int SEARCH_LIMIT
Constructor Detail |
---|
public LyDashboardController(LySession session, LyController parent, LyAction action, LyClassInfo classInfo, LyObjectList objects)
session
- current session associated to the controller. The controller automatically
registers on the specified session.parent
- parent controller (or null for 'root' controller). Controller hierarchy
indicates a child controller (for example a dialog created from a main view)action
- related action. If an action is specified, the controller uses action
parameters (action name, action specific XML view description ...)classInfo
- the associated classInfoobjects
- This parameter is kept for compatibility and introspection (unused).Method Detail |
---|
public void free(LyController controller)
free
in class LyMultiAreaController
controller
- parent controllerLyAreaController.free()
public java.lang.String getTitle()
getTitle
in class LyAreaController
public void reset(boolean full)
reset
in class LyAreaController
full
- Boolean indicating if a full reset (including reset of datas) is requiered or not
(only reset graphical area).public java.lang.Class<?> getBehaviorInterface()
getBehaviorInterface
in class LyAreaController
public void actionDemand(LyActionDemand demand)
actionDemand
in class LyMultiAreaController
demand
- demand parameters sent by the view component.LyController.demandPerformed(leon.view.event.LyDemand)
public void selectionDemand(LySelectionDemand demand)
This method is called by demandPerformed and may be overriden in subclasses.
selectionDemand
in class LyController
demand
- demand parameters sent by the view component.LyController.selectionDemand(leon.view.event.LySelectionDemand)
public LyArea getTargetArea(LyAction action)
action
- Action that will be displayed in the target area.
public void setAction(LyAction action)
action
- New main action.public void setAction(LyAction action, boolean deleteOnClose)
setAction
in class LyMultiAreaController
action
- New main action.deleteOnClose
- Delete controller when action is changed.public void closeCurrentView(boolean closeTabs)
closeTabs
- true to close all tabspublic void closeAllViews()
public void updateWindowMenu()
public boolean useSingleView()
public boolean useTabs()
public LyAreaController getDisplayedAreaController()
public LyInfoList<LyAction> getOpenedActions()
public LyInfoList<LyAction> getActions()
public boolean isViewResizable()
isViewResizable
in class LyMultiAreaController
public java.lang.String getImage()
getImage
in class LyAreaController
public void addViewController(java.lang.String id, LyViewController controller)
id
- The action id.controller
- The view controller to keep.public java.util.Hashtable<java.lang.String,LyViewController> getViewControllers()
public void setImage(LyAction action, java.lang.String image)
action
- action to be modified in the dashboardimage
- new image key or path.public void setEnabled(LyAction action, boolean enable)
action
- action to be enabled/disabled in the dashboardenable
- new action statuspublic java.lang.String getHelpFile()
getHelpFile
in class LyAreaController
public LyAction getSocialAction()
public void updateViewFromValues(LyDemand demand)
LyController
updateViewFromValues
in class LyController
demand
- demand parameters sent by the view component.
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |