Package ro.sync.ecss.extensions.commons.table.properties

Class TabInfo

java.lang.Object

ro.sync.ecss.extensions.commons.table.properties.TabInfo

@API(type=INTERNAL,
     src=PUBLIC)
public class TabInfo
extends java.lang.Object

Information associated with a tab from the 'Table Properties' dialog.

Constructor Summary

Constructors

Constructor	Description
TabInfo(java.lang.String key, java.util.List<TableProperty> properties, java.util.List<AuthorElement> nodes)	Constructor.
TabInfo(java.lang.String key, java.util.List<TableProperty> properties, java.util.List<AuthorElement> nodes, java.util.List<AuthorDocumentFragment> fragmentsToInsert, javax.swing.text.Position[] offsets)	Constructor.
TabInfo(java.lang.String key, java.util.List<TableProperty> properties, java.util.List<AuthorElement> nodes, java.util.List<AuthorDocumentFragment> fragmentsToInsert, javax.swing.text.Position[] offsets, java.lang.String contextInfo)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getContextInfo()	Obtain the context information of the current tab.
java.util.List<AuthorDocumentFragment>	getFragmentsToInsert()	Get the fragments which will be inserted in the document.
javax.swing.text.Position[]	getInsertOffsets()	Get the position where the fragments will be inserted.
java.util.List<AuthorElement>	getNodes()	The nodes whose properties will be edited.
java.util.List<TableProperty>	getProperties()	Obtain the list with the properties which will be presented in the current tab.
java.lang.String	getTabKey()	Return the tab key name.
void	setContextInfo(java.lang.String contextInfo)	Set the context information.
void	setFragmentsToInsert(java.util.List<AuthorDocumentFragment> fragmentsToInsert)	Set the fragments which will be inserted in the document.
void	setInsertOffsets(javax.swing.text.Position[] positions)	Sets the position where the fragments will be inserted.
void	setNodes(java.util.List<AuthorElement> nodes)	Set the nodes whose properties will be edited.
void	setProperties(java.util.List<TableProperty> properties)	Set the list with the properties which will be presented in the current tab.
void	setTabKey(java.lang.String tabKey)	Set the tab key name.

Methods inherited from class java.lang.Object

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

Constructor Detail

TabInfo

public TabInfo(java.lang.String key,
               java.util.List<TableProperty> properties,
               java.util.List<AuthorElement> nodes)

Constructor.

Parameters:

key - The tab key name. If no translation for the tab, then it represents the name of the tab.

properties - The list with the properties which will be presented in the current tab.

nodes - The nodes whose properties will be edited.

TabInfo

public TabInfo(java.lang.String key,
               java.util.List<TableProperty> properties,
               java.util.List<AuthorElement> nodes,
               java.util.List<AuthorDocumentFragment> fragmentsToInsert,
               javax.swing.text.Position[] offsets)

Constructor.

Parameters:

key - The tab key name. If no translation for the tab, then it represents the name of the tab.

properties - The list with the properties which will be presented in the current tab.

nodes - The nodes whose properties will be edited.

fragmentsToInsert - The list of AuthorDocumentFragments to be inserted.

offsets - The offsets where the new fragments will be inserted.

TabInfo

public TabInfo(java.lang.String key,
               java.util.List<TableProperty> properties,
               java.util.List<AuthorElement> nodes,
               java.util.List<AuthorDocumentFragment> fragmentsToInsert,
               javax.swing.text.Position[] offsets,
               java.lang.String contextInfo)

Constructor.

Parameters:

key - The tab key name. If no translation for the tab, then it represents the name of the tab.

properties - The list with the properties which will be presented in the current tab.

nodes - The nodes whose properties will be edited.

fragmentsToInsert - The fragments to be inserted.

offsets - The offsets where the new fragments will be inserted.

contextInfo - The context information of the current tab. If no context information, then it will be null.

Method Detail

getTabKey

public java.lang.String getTabKey()

Return the tab key name. If no translation for the tab, then it represents the name of the tab.

Returns:

Returns the tab key.

setTabKey

public void setTabKey(java.lang.String tabKey)

Set the tab key name. If no translation for the tab, then it represents the name of the tab.

Parameters:

tabKey - The new tab Key.

getProperties

public java.util.List<TableProperty> getProperties()

Obtain the list with the properties which will be presented in the current tab.

Returns:

Returns the the list with the properties which will be presented in the current tab.

setProperties

public void setProperties(java.util.List<TableProperty> properties)

Set the list with the properties which will be presented in the current tab.

Parameters:

properties - The new properties to set.

getNodes

public java.util.List<AuthorElement> getNodes()

The nodes whose properties will be edited.

Returns:

Returns the nodes whose properties will be edited..

setNodes

public void setNodes(java.util.List<AuthorElement> nodes)

Set the nodes whose properties will be edited.

Parameters:

nodes - The new list of nodes to set.

getFragmentsToInsert

public java.util.List<AuthorDocumentFragment> getFragmentsToInsert()

Get the fragments which will be inserted in the document.

Returns:

Returns the fragments which will be inserted in the document.

setFragmentsToInsert

public void setFragmentsToInsert(java.util.List<AuthorDocumentFragment> fragmentsToInsert)

Set the fragments which will be inserted in the document.

Parameters:

fragmentsToInsert - The fragments which will be inserted in the document.

getInsertOffsets

public javax.swing.text.Position[] getInsertOffsets()

Get the position where the fragments will be inserted.

Returns:

Returns the position where the fragments will be inserted.

setInsertOffsets

public void setInsertOffsets(javax.swing.text.Position[] positions)

Sets the position where the fragments will be inserted.

Parameters:

positions - The position where the fragments will be inserted.

getContextInfo

public java.lang.String getContextInfo()

Obtain the context information of the current tab.

Returns:

Returns the context information.

setContextInfo

public void setContextInfo(java.lang.String contextInfo)

Set the context information.

Parameters:

contextInfo - The context information to set.