Module platform

Package de.grogra.pf.ui

Class UI

java.lang.Object

de.grogra.pf.registry.Plugin

de.grogra.pf.ui.UI

All Implemented Interfaces:

RegistryContext, ResourceConverter

public final class UI
extends Plugin
implements ResourceConverter

Field Summary

Fields

Modifier and Type	Field	Description
static final I18NBundle	I18N

Fields inherited from interface de.grogra.util.ResourceConverter

CAT, LINK

Constructor Summary

Constructors

Constructor	Description
UI()

Method Summary

Modifier and Type	Method	Description
boolean	canHandleConversion(String name)
static Map	configureViewerParams(Map params, URL url, String mimeType, RegistryContext ctx)
static void	consume(Object event)
Object	convert(String name, String argument, I18NBundle bundle)
static ProgressMonitor	createProgressAdapter(Context ctx)
static void	dumpCommand(Item item, Object info, Context ctx)
static void	executeHyperlinkURL(String url, Context ctx)
static void	executeLockedly(Lockable resource, boolean write, Command cmd, Object arg, Context ctx, int flags)
static void	executeLockedly(Lockable resource, boolean write, Command cmd, Object arg, Context ctx, int flags, boolean passLockAsArg)
static StringMap	getArgs(Context ctx, Map parent)
static String	getClassDescription(Class cls)
static String[]	getDocuments(Map params)
static IconSource	getIcon(String name)
static IconSource	getIcon(String systemId, String mimeType, IconSource base, RegistryContext ctx, boolean useDefaultIcon)
static JobManager	getJobManager(Context ctx)
static ModifiableMap	getOptions(Context ctx)
static Registry	getRegistry(Context ctx)
static Node	getRootOfProjectGraph(Context ctx)
static ThreadContext	getThreadContext(Context ctx)
static UITree	getUITreeForMenu(Context ctx, Item menu, Map pipelineParams)
static boolean	isAvailable(Item i, Context ctx)
static boolean	isConsumed(EventObject e)
static boolean	isEnabled(Item i, Context ctx)
static Described	nodeToDescribed(UINodeHandler h, Object node)
static Point	parsePlainTextLocation(String ref)
static Point[]	parsePlainTextRange(String ref)
static void	putDocuments(TextEditor e, ModifiableMap out)
static void	setField(Node node, PersistenceField field, Object value, Context ctx)
static void	setMenu(Panel panel, Item menu, Map pipelineParams)
void	startup()	This method is invoked when the plugin is activated, i.e., when the first class defined by the plugin is loaded (except for the Plugin class itself).

Methods inherited from class de.grogra.pf.registry.Plugin

checkConfigure, getI18NBundle, getPluginDescriptor, getRegistry, initialize, shutdown

Methods inherited from class java.lang.Object

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

Field Details

I18N

public static final I18NBundle I18N

Constructor Details

UI

public UI()

Method Details

getIcon

public static IconSource getIcon(String name)

startup

public void startup()

Description copied from class: Plugin

This method is invoked when the plugin is activated, i.e., when the first class defined by the plugin is loaded (except for the Plugin class itself). The default implementation executes all executable items in the directory /hooks/startup/name, where name is the name of the plugin.

The method Plugin.initialize() has been invoked before. Only if this invocation has returned true, the plugin may be activated.

Overrides:

startup in class Plugin

canHandleConversion

public boolean canHandleConversion(String name)

Specified by:

canHandleConversion in interface ResourceConverter

convert

public Object convert(String name,
 String argument,
 I18NBundle bundle)

Specified by:

convert in interface ResourceConverter

getJobManager

public static JobManager getJobManager(Context ctx)

getThreadContext

public static ThreadContext getThreadContext(Context ctx)

getRootOfProjectGraph

public static Node getRootOfProjectGraph(Context ctx)

getRegistry

public static Registry getRegistry(Context ctx)

getArgs

public static StringMap getArgs(Context ctx,
 Map parent)

getUITreeForMenu

public static UITree getUITreeForMenu(Context ctx,
 Item menu,
 Map pipelineParams)

setMenu

public static void setMenu(Panel panel,
 Item menu,
 Map pipelineParams)

isAvailable

public static boolean isAvailable(Item i,
 Context ctx)

isEnabled

public static boolean isEnabled(Item i,
 Context ctx)

isConsumed

public static boolean isConsumed(EventObject e)

consume

public static void consume(Object event)

dumpCommand

public static void dumpCommand(Item item,
 Object info,
 Context ctx)

createProgressAdapter

public static ProgressMonitor createProgressAdapter(Context ctx)

getClassDescription

public static String getClassDescription(Class cls)

nodeToDescribed

public static Described nodeToDescribed(UINodeHandler h,
 Object node)

configureViewerParams

public static Map configureViewerParams(Map params,
 URL url,
 String mimeType,
 RegistryContext ctx)

executeHyperlinkURL

public static void executeHyperlinkURL(String url,
 Context ctx)

parsePlainTextRange

public static Point[] parsePlainTextRange(String ref)

parsePlainTextLocation

public static Point parsePlainTextLocation(String ref)

putDocuments

public static void putDocuments(TextEditor e,
 ModifiableMap out)

getDocuments

public static String[] getDocuments(Map params)

getIcon

public static IconSource getIcon(String systemId,
 String mimeType,
 IconSource base,
 RegistryContext ctx,
 boolean useDefaultIcon)

getOptions

public static ModifiableMap getOptions(Context ctx)

executeLockedly

public static void executeLockedly(Lockable resource,
 boolean write,
 Command cmd,
 Object arg,
 Context ctx,
 int flags,
 boolean passLockAsArg)

executeLockedly

public static void executeLockedly(Lockable resource,
 boolean write,
 Command cmd,
 Object arg,
 Context ctx,
 int flags)

setField

public static void setField(Node node,
 PersistenceField field,
 Object value,
 Context ctx)