core/com.nokia.carbide.discovery.ui/src/com/nokia/carbide/internal/discovery/ui/extension/IPortalExtension.java
author dadubrow
Mon, 26 Jul 2010 15:11:10 -0500
changeset 1684 c2eba6dabd38
parent 1661 core/com.nokia.carbide.discovery.ui/src/com/nokia/carbide/internal/discovery/ui/extension/IPortalPage.java@cd8159f371c7
permissions -rw-r--r--
refactor to allow better support for multiple layers
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.jface.resource.ImageDescriptor;
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    21
import org.eclipse.swt.widgets.Composite;
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    22
import org.eclipse.swt.widgets.Control;
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    23
import org.eclipse.ui.IEditorPart;
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    24
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    25
/**
1684
c2eba6dabd38 refactor to allow better support for multiple layers
dadubrow
parents: 1661
diff changeset
    26
 * Interface to a portal extension
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    27
 */
1684
c2eba6dabd38 refactor to allow better support for multiple layers
dadubrow
parents: 1661
diff changeset
    28
public interface IPortalExtension {
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    29
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    30
	/**
1684
c2eba6dabd38 refactor to allow better support for multiple layers
dadubrow
parents: 1661
diff changeset
    31
	 * Interface to an action/navigation bar for the portal extension
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    32
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    33
	public interface IActionBar {
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    34
		
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    35
		/**
1615
d5f384bf1e88 more portal
dadubrow
parents: 1609
diff changeset
    36
		 * Required title for the action bar
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    37
		 * @return String
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    38
		 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    39
		String getTitle();
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    40
		
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    41
		/**
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    42
		 * Actions shown in the action bar:
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    43
		 * Required: text and run() methods
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    44
		 * Optional: tool tip text
1684
c2eba6dabd38 refactor to allow better support for multiple layers
dadubrow
parents: 1661
diff changeset
    45
		 * Unused: image/check
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    46
		 * @return IAction
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    47
		 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    48
		IAction[] getActions();
1661
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    49
		
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    50
		/**
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    51
		 * Action ids for actions that should be emphasized in the action bar (e.g., bold font)
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    52
		 * @return String[] or null
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    53
		 */
cd8159f371c7 multiple changes:
dadubrow
parents: 1615
diff changeset
    54
		String[] getHighlightedActionIds();
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    55
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    56
	}
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    57
	
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    58
	/**
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    59
	 * 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
    60
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    61
	public interface IActionUIUpdater {
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
		 * Update the UI for a specific action by id
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    65
		 * @param actionId
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    66
		 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    67
		void update(String actionId);
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    68
		
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    69
		/**
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    70
		 * Update the UI for all actions in the IActionBar
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    71
		 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    72
		void updateAll();
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
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    76
	/**
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    77
	 * Required title text used by main navigation bar
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    78
	 * @return String
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    79
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    80
	String getText();
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    81
	
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    82
	/**
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    83
	 * Required image descriptor used by main navigation bar
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    84
	 * @return ImageDescriptor
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    85
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    86
	ImageDescriptor getImageDescriptor();
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    87
	
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    88
	/**
1684
c2eba6dabd38 refactor to allow better support for multiple layers
dadubrow
parents: 1661
diff changeset
    89
	 * Called to create the control for the extension
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    90
	 * @param parent Composite
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    91
	 * @param part IEditorPart
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    92
	 * @return Control
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    93
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    94
	Control createControl(Composite parent, IEditorPart part);
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    95
	
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    96
	/**
1684
c2eba6dabd38 refactor to allow better support for multiple layers
dadubrow
parents: 1661
diff changeset
    97
	 * Called to initialize the extension when shown for the first time
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    98
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
    99
	void init();
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   100
	
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   101
	/**
1684
c2eba6dabd38 refactor to allow better support for multiple layers
dadubrow
parents: 1661
diff changeset
   102
	 * Return action bars for the extension
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   103
	 * @param part IEditorPart
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   104
	 * @param updater IActionUIUpdater
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   105
	 * @return IActionBar[]
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   106
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   107
	IActionBar[] createCommandBars(IEditorPart part, IActionUIUpdater updater);
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   108
	
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   109
	/**
1684
c2eba6dabd38 refactor to allow better support for multiple layers
dadubrow
parents: 1661
diff changeset
   110
	 * Called to dispose internal resources of the extension
1609
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   111
	 */
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   112
	void dispose();
085da1889c59 Portal initial commit
dadubrow
parents:
diff changeset
   113
}