core/com.nokia.carbide.discovery.ui/src/com/nokia/carbide/internal/discovery/ui/extension/IActionBar.java
author dadubrow
Mon, 02 Aug 2010 08:44:45 -0500
changeset 1734 bf670d38123a
permissions -rw-r--r--
More portal framework changes: support for page command bars in page extension ordering across layers on page abstract discovery UI pages improvements to open editor asap and defer updates if needed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1734
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
     1
/*
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
     3
* All rights reserved.
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
     4
* This component and the accompanying materials are made available
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
     6
* which accompanies this distribution, and is available
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
     8
*
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
     9
* Initial Contributors:
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    11
*
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    12
* Contributors:
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    13
*
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    14
* Description: 
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    15
*
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    16
*/
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    17
package com.nokia.carbide.internal.discovery.ui.extension;
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    18
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    19
import org.eclipse.jface.action.IAction;
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    20
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    21
/**
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    22
 * Interface to an action/navigation bar for the portal portal page layer
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    23
 */
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    24
public interface IActionBar {
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    25
	
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    26
	/**
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    27
	 * Required title for the action bar
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    28
	 * @return String
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    29
	 */
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    30
	String getTitle();
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    31
	
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    32
	/**
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    33
	 * Actions shown in the action bar:
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    34
	 * Required: text and run() methods
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    35
	 * Optional: tool tip text
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    36
	 * Unused: image/check
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    37
	 * @return IAction
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    38
	 */
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    39
	IAction[] getActions();
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    40
	
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    41
	/**
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    42
	 * Action ids for actions that should be emphasized in the action bar (e.g., bold font)
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    43
	 * @return String[] or null
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    44
	 */
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    45
	String[] getHighlightedActionIds();
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    46
bf670d38123a More portal framework changes:
dadubrow
parents:
diff changeset
    47
}