core/com.nokia.carbide.discovery.ui/src/com/nokia/carbide/internal/discovery/ui/extension/IPortalPageLayer.java
author dadubrow
Tue, 27 Jul 2010 15:29:41 -0500
changeset 1705 71a151b1b515
parent 1684 core/com.nokia.carbide.discovery.ui/src/com/nokia/carbide/internal/discovery/ui/extension/IPortalExtension.java@c2eba6dabd38
child 1721 18638adda547
permissions -rw-r--r--
add support for multiple layers per page
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
     1
/*
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
     3
* All rights reserved.
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
     4
* This component and the accompanying materials are made available
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
     6
* which accompanies this distribution, and is available
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
     8
*
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
     9
* Initial Contributors:
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    11
*
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    12
* Contributors:
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    13
*
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    14
* Description: 
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    15
*
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    16
*/
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    17
package com.nokia.carbide.internal.discovery.ui.extension;
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    18
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    19
import org.eclipse.jface.action.IAction;
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    20
import org.eclipse.swt.widgets.Composite;
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    21
import org.eclipse.swt.widgets.Control;
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    22
import org.eclipse.ui.IEditorPart;
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    23
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    24
/**
1705
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    25
 * Interface to a portal page layer extension
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    26
 */
1705
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    27
public interface IPortalPageLayer {
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    28
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    29
	/**
1705
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    30
	 * The title of this portal page layer
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    31
	 * @return String
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    32
	 */
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    33
	String getTitle();
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    34
	
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    35
	/**
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    36
	 * Interface to an action/navigation bar for the portal portal page layer
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    37
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    38
	public interface IActionBar {
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    39
		
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    40
		/**
1615
d5f384bf1e88 more portal
dadubrow
parents: 1609
diff changeset
    41
		 * Required title for the action bar
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    42
		 * @return String
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    43
		 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    44
		String getTitle();
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    45
		
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    46
		/**
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    47
		 * Actions shown in the action bar:
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    48
		 * Required: text and run() methods
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    49
		 * Optional: tool tip text
1684
c2eba6dabd38 refactor to allow better support for multiple layers
dadubrow
parents: 1661
diff changeset
    50
		 * Unused: image/check
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    51
		 * @return IAction
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    52
		 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    53
		IAction[] getActions();
1661
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    54
		
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    55
		/**
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    56
		 * Action ids for actions that should be emphasized in the action bar (e.g., bold font)
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    57
		 * @return String[] or null
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    58
		 */
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    59
		String[] getHighlightedActionIds();
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    60
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    61
	}
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    62
	
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    63
	/**
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    64
	 * Interface allowing the UI for provided actions of an IActionBar to be updated (e.g., enabled state)
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    65
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    66
	public interface IActionUIUpdater {
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    67
		
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    68
		/**
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    69
		 * Update the UI for a specific action by id
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    70
		 * @param actionId
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    71
		 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    72
		void update(String actionId);
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    73
		
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    74
		/**
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    75
		 * Update the UI for all actions in the IActionBar
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    76
		 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    77
		void updateAll();
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    78
		
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    79
	}
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    80
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    81
	/**
1705
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    82
	 * Called to create the control for the portal page layer
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    83
	 * @param parent Composite
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    84
	 * @param part IEditorPart
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    85
	 * @return Control
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    86
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    87
	Control createControl(Composite parent, IEditorPart part);
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    88
	
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    89
	/**
1705
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    90
	 * Called to initialize the portal page layer when shown for the first time
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    91
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    92
	void init();
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    93
	
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    94
	/**
1705
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
    95
	 * Return action bars for the portal page layer
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    96
	 * @param part IEditorPart
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    97
	 * @param updater IActionUIUpdater
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    98
	 * @return IActionBar[]
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    99
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   100
	IActionBar[] createCommandBars(IEditorPart part, IActionUIUpdater updater);
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   101
	
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   102
	/**
1705
71a151b1b515 add support for multiple layers per page
dadubrow
parents: 1684
diff changeset
   103
	 * Called to dispose internal resources of the portal page layer
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   104
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   105
	void dispose();
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   106
}