Package org.nuclos.api.ui.layout

Interface LayoutComponent<PK>

public interface LayoutComponent<PK>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	LayoutComponent.LayoutComponentType	layout component type

Method Summary

Modifier and Type	Method	Description
void	addLayoutComponentListener(LayoutComponentListener<PK> listener)	add new LayoutComponentListener to component
JComponent	getComponent(LayoutComponent.LayoutComponentType type)
Property[]	getComponentProperties()
String[]	getComponentPropertyLabels()
LayoutComponentContext	getContext()
Collection<LayoutComponentListener<PK>>	getLayoutComponentListeners()	get the listeners for layout components
String	getName()
EnumSet<LayoutComponent.LayoutComponentType>	getSupportedTypes()	get set of supported LayoutComponent.LayoutComponentType
void	removeLayoutComponentListener(LayoutComponentListener<PK> listener)	remove LayoutComponentListener from component
void	setBorder(Border border)
void	setName(String name)
void	setPreferences(Preferences prefs)
void	setPreferredSize(Dimension preferredSize)
void	setProperty(String name, Object value)
void	setTabController(TabController tabController)	Give the layout component a handle for controlling some aspects of the tab it is displayed on.

Method Details

getComponent

JComponent getComponent(LayoutComponent.LayoutComponentType type)

Parameters:

type - the type LayoutComponent.LayoutComponentType of the requested component

Returns:

component

getSupportedTypes

EnumSet<LayoutComponent.LayoutComponentType> getSupportedTypes()

get set of supported LayoutComponent.LayoutComponentType

Returns:

setPreferences

void setPreferences(Preferences prefs)

Parameters:

prefs - also for restoring state from preferences

setName

void setName(String name)

Parameters:

name -

getName

String getName()

Returns:

name for component

setBorder

void setBorder(Border border)

Parameters:

border -

setPreferredSize

void setPreferredSize(Dimension preferredSize)

Parameters:

preferredSize -

setProperty

void setProperty(String name,
 Object value)

Parameters:

name -

value -

setTabController

void setTabController(TabController tabController)

Give the layout component a handle for controlling some aspects of the tab it is displayed on.

Parameters:

tabController - control handle

Since:

Nuclos 4.3.2

See Also:

• TabController

getComponentProperties

Property[] getComponentProperties()

Returns:

null if no additional properties are required. Otherwise return array of Property. supported types are: java.lang.Boolean java.lang.String java.lang.Integer java.awt.Dimension java.awt.Color java.awt.Font org.nuclos.common.NuclosScript org.nuclos.common.NuclosTranslationMap org.nuclos.common.NuclosValuelistProvider

getComponentPropertyLabels

String[] getComponentPropertyLabels()

Returns:

null if no additional properties are required. Otherwise return String[]

getContext

LayoutComponentContext getContext()

Returns:

context LayoutComponentContext for layout component

getLayoutComponentListeners

Collection<LayoutComponentListener<PK>> getLayoutComponentListeners()

get the listeners for layout components

Returns:

addLayoutComponentListener

void addLayoutComponentListener(LayoutComponentListener<PK> listener)

add new LayoutComponentListener to component

Parameters:

listener - the LayoutComponentListener

removeLayoutComponentListener

void removeLayoutComponentListener(LayoutComponentListener<PK> listener)

remove LayoutComponentListener from component

Parameters:

listener - the LayoutComponentListener