| java.lang.Object
 com.flexive.shared.structure.FxStructureElement
com.flexive.shared.structure.FxProperty
com.flexive.shared.structure.FxPropertyEdit
| FxPropertyEdit | | public class FxPropertyEdit extends FxProperty (Code) | | FxProperty used for structure editing
author:
Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at) |
| Method Summary | |
| public void | checkConsistency()
| | public void | clearOption(String key)
| | public static FxPropertyEdit | createNew(FxProperty base, String newName, boolean autoUniquePropertyName)
| | public static FxPropertyEdit | createNew(FxProperty base, String newName)
| | public static FxPropertyEdit | createNew(String name, FxString description, FxString hint, boolean overrideBaseMultiplicity, FxMultiplicity multiplicity, boolean overrideACL, ACL acl, FxDataType dataType, FxString defaultValue, boolean fulltextIndexed, FxType referencedType, FxSelectList referencedList, List<FxStructureOption> options)
| | public static FxPropertyEdit | createNew(String name, FxString description, FxString hint, FxMultiplicity multiplicity, ACL acl, FxDataType dataType)
| | public int | getAssignmentDefaultMultiplicity()
| | public List<FxStructureOption> | getOptions()
| | public boolean | isAutoUniquePropertyName()
| | public boolean | isNew()
| | public FxPropertyEdit | setACL(ACL acl)
| | public FxPropertyEdit | setAssignmentDefaultMultiplicity(int defaultMultiplicity)
This value set will only be used when creating a new property and will be set for the created assignment!
Set the default multiplicity (used i.e. | | public FxPropertyEdit | setAutoUniquePropertyName(boolean autoUniquePropertyName)
| | public FxPropertyEdit | setDataType(FxDataType dataType)
| | public FxPropertyEdit | setFulltextIndexed(boolean fulltextIndexed)
| | public FxPropertyEdit | setHint(FxString hint)
| | public FxPropertyEdit | setInOverview(boolean inOverview)
| | public FxPropertyEdit | setLabel(FxString label)
| | public FxPropertyEdit | setMultiLang(boolean multiLang)
| | public FxPropertyEdit | setMultiLine(boolean multiLine)
| | public FxPropertyEdit | setMultiplicity(FxMultiplicity multiplicity)
| | public FxPropertyEdit | setName(String name)
| | public FxPropertyEdit | setOption(String key, boolean overrideable, String value)
| | public FxPropertyEdit | setOption(String key, boolean overrideable, boolean value)
| | public FxPropertyEdit | setOptionOverrideable(String key, boolean overrideable)
| | public FxPropertyEdit | setOverrideACL(boolean overrideACL)
| | public FxPropertyEdit | setOverrideHTMLEditor(boolean overrideHTMLEditor)
| | public FxPropertyEdit | setOverrideMultiLang(boolean overrideMultiLang)
| | public FxPropertyEdit | setOverrideMultiLine(boolean overrideMultiLine)
| | public FxPropertyEdit | setOverrideMultiplicity(boolean overrideMultiplicity)
| | public FxPropertyEdit | setOverrideOverview(boolean overrideOverview)
| | public FxPropertyEdit | setOverrideSearchable(boolean overrideSearchable)
| | public FxPropertyEdit | setReferencedList(FxSelectList referencedList)
| | public FxPropertyEdit | setReferencedType(FxType referencedType)
| | public FxPropertyEdit | setSearchable(boolean searchable)
| | public FxPropertyEdit | setUniqueMode(UniqueMode uniqueMode)
| | public FxPropertyEdit | setUseHTMLEditor(boolean useHTMLEditor)
|
| FxPropertyEdit | | public FxPropertyEdit(FxProperty prop)(Code) | | Make an editable instance of an existing property
Parameters:
prop - original property |
| checkConsistency | | public void checkConsistency()(Code) | | Perform some consistency checks, called internally!
|
| clearOption | | public void clearOption(String key)(Code) | | Clear an option entry
Parameters:
key - option name |
| createNew | | public static FxPropertyEdit createNew(FxProperty base, String newName, boolean autoUniquePropertyName) throws FxInvalidParameterException(Code) | | Create a clone of an existing property with a new name
Parameters:
base - property to clone
Parameters:
newName - new name to assign
Parameters:
autoUniquePropertyName - if the property name already exists, try to find a unique one (by appending "_([counter])").Useful if creating property assignments and the used property name is not important FxPropertyEdit
throws:
FxInvalidParameterException - on errors |
| createNew | | public static FxPropertyEdit createNew(FxProperty base, String newName)(Code) | | Create a clone of an existing property with a new name
Parameters:
base - property to clone
Parameters:
newName - new name to assign (has to be mandatorwide unique!) FxPropertyEdit |
| createNew | | public static FxPropertyEdit createNew(String name, FxString description, FxString hint, boolean overrideBaseMultiplicity, FxMultiplicity multiplicity, boolean overrideACL, ACL acl, FxDataType dataType, FxString defaultValue, boolean fulltextIndexed, FxType referencedType, FxSelectList referencedList, List<FxStructureOption> options)(Code) | | Create a new FxPropertyEdit instance
Parameters:
name - (mandator wide unique) name of the property
Parameters:
description - description
Parameters:
hint - hint message
Parameters:
overrideBaseMultiplicity - are assignments allowed to override this properties multiplicity?
Parameters:
multiplicity - multiplicity
Parameters:
overrideACL - are assignments allowed to override this properties ACL?
Parameters:
acl - ACL
Parameters:
dataType - FxDataType
Parameters:
defaultValue - default value to assign
Parameters:
fulltextIndexed - should values of this property be fulltext indexed?
Parameters:
referencedType - if dataType is reference this is the referenced type
Parameters:
referencedList - if dataType is (multi) select list this is the referenced list
Parameters:
options - this properties options FxPropertyEdit instance |
| createNew | | public static FxPropertyEdit createNew(String name, FxString description, FxString hint, FxMultiplicity multiplicity, ACL acl, FxDataType dataType)(Code) | | Create a new FxPropertyEdit instance - simplified with many defaults (everything set to true except useHTMLEditor)
Parameters:
name - (mandator wide unique) name of the property
Parameters:
description - description
Parameters:
hint - hint message
Parameters:
multiplicity - multiplicity
Parameters:
acl - ACL
Parameters:
dataType - FxDataType FxPropertyEdit instance |
| getAssignmentDefaultMultiplicity | | public int getAssignmentDefaultMultiplicity()(Code) | | Get the created assignments default multiplicity
default multiplicity |
| getOptions | | public List<FxStructureOption> getOptions()(Code) | | Get a (unmodifiable) list of all options set for this property
(unmodifiable) list of all options set for this property |
| isAutoUniquePropertyName | | public boolean isAutoUniquePropertyName()(Code) | | If creating a new property and the property name (not assignment! xalias will remain!) is taken probe for and
use a unique property name?
probe for unique property name if a property with the requested xalias already exist? |
| isNew | | public boolean isNew()(Code) | | Is this a new property
if this is a new property |
| setACL | | public FxPropertyEdit setACL(ACL acl)(Code) | | Set the ACL
Parameters:
acl - ACL the property itself, useful for chained calls |
| setAssignmentDefaultMultiplicity | | public FxPropertyEdit setAssignmentDefaultMultiplicity(int defaultMultiplicity)(Code) | | This value set will only be used when creating a new property and will be set for the created assignment!
Set the default multiplicity (used i.e. in user interfaces editors and determines the amount of values that will
be initialized when creating an empty element).
If the set value is < min or > max multiplicity of this assignment it will
be auto adjusted to the next valid value without throwing an exception
Parameters:
defaultMultiplicity - the default multiplicity this |
| setAutoUniquePropertyName | | public FxPropertyEdit setAutoUniquePropertyName(boolean autoUniquePropertyName)(Code) | | If creating a new property and the property name (not assignment! xalias will remain!) is taken probe for and
use a unique property name?
Parameters:
autoUniquePropertyName - probe for a unique propery name if a property with the requested xalias already exist? the property itself, useful for chained calls |
| setDataType | | public FxPropertyEdit setDataType(FxDataType dataType)(Code) | | Set the data type
Parameters:
dataType - data type the property itself, useful for chained calls |
| setFulltextIndexed | | public FxPropertyEdit setFulltextIndexed(boolean fulltextIndexed)(Code) | | Set if values of this property should be fulltext indexed?
Parameters:
fulltextIndexed - should values of this property be fulltext indexed? the property itself, useful for chained calls |
| setHint | | public FxPropertyEdit setHint(FxString hint)(Code) | | Set the hint message
Parameters:
hint - hint message the property itself, useful for chained calls |
| setInOverview | | public FxPropertyEdit setInOverview(boolean inOverview)(Code) | | Set overview appearance setting
Parameters:
inOverview - overview appearance setting the property itself, useful for chained calls |
| setLabel | | public FxPropertyEdit setLabel(FxString label)(Code) | | Set the label
Parameters:
label - the label the property itself, useful for chained calls |
| setMultiLang | | public FxPropertyEdit setMultiLang(boolean multiLang)(Code) | | Set multilinguality
Parameters:
multiLang - are values of this property multilingual? the property itself, useful for chained calls |
| setMultiLine | | public FxPropertyEdit setMultiLine(boolean multiLine)(Code) | | Set multiline display ability
Parameters:
multiLine - render property in multiple lines? the property itself, useful for chained calls |
| setMultiplicity | | public FxPropertyEdit setMultiplicity(FxMultiplicity multiplicity)(Code) | | Set the multiplicity
Parameters:
multiplicity - multiplicity the property itself, useful for chained calls |
| setOption | | public FxPropertyEdit setOption(String key, boolean overrideable, String value)(Code) | | Set an option
Parameters:
key - option key
Parameters:
overrideable - is the option overrideable from assignments?
Parameters:
value - value of the option the property itself, useful for chained calls |
| setOption | | public FxPropertyEdit setOption(String key, boolean overrideable, boolean value)(Code) | | Set a boolean option
Parameters:
key - option key
Parameters:
overrideable - is the option overrideable from assignments?
Parameters:
value - value of the option the property itself, useful for chained calls |
| setOptionOverrideable | | public FxPropertyEdit setOptionOverrideable(String key, boolean overrideable)(Code) | | Change the overrideable status of an option, will only have effect if the option exists!
Parameters:
key - option key
Parameters:
overrideable - overrideable status the property itself, useful for chained calls |
| setOverrideACL | | public FxPropertyEdit setOverrideACL(boolean overrideACL)(Code) | | Set if assignments of this propery are allowed to override this properties ACL?
Parameters:
overrideACL - are assignments allowed to override this properties ACL? the property itself, useful for chained calls |
| setOverrideHTMLEditor | | public FxPropertyEdit setOverrideHTMLEditor(boolean overrideHTMLEditor)(Code) | | Set if assignments are allowed to override this properties use of HTML editor setting?
Parameters:
overrideHTMLEditor - are assignments allowed to override this properties use of HTML editor setting? the property itself, useful for chained calls |
| setOverrideMultiLang | | public FxPropertyEdit setOverrideMultiLang(boolean overrideMultiLang)(Code) | | Set if assignments are allowed to override this properties multilanguage setting?
Parameters:
overrideMultiLang - are assignments allowed to override this properties multilanguage setting? the property itself, useful for chained calls |
| setOverrideMultiLine | | public FxPropertyEdit setOverrideMultiLine(boolean overrideMultiLine)(Code) | | Set if assignments are allowed to override this properties multiline setting?
Parameters:
overrideMultiLine - are assignments allowed to override this properties multiline setting? the property itself, useful for chained calls |
| setOverrideMultiplicity | | public FxPropertyEdit setOverrideMultiplicity(boolean overrideMultiplicity)(Code) | | Set if assignments are allowed to override this properties multiplicity?
Parameters:
overrideMultiplicity - are assignments allowed to override this properties multiplicity? the property itself, useful for chained calls |
| setOverrideOverview | | public FxPropertyEdit setOverrideOverview(boolean overrideOverview)(Code) | | Set if assignments are allowed to override this properties appearance in overviews?
Parameters:
overrideOverview - are assignments allowed to override this properties appearance in overviews? the property itself, useful for chained calls |
| setOverrideSearchable | | public FxPropertyEdit setOverrideSearchable(boolean overrideSearchable)(Code) | | Set if assignments are allowed to override this properties multilanguage setting?
Parameters:
overrideSearchable - are assignments allowed to override this properties multilanguage setting? the property itself, useful for chained calls |
| setReferencedList | | public FxPropertyEdit setReferencedList(FxSelectList referencedList)(Code) | | If this propery is a (multi) select list, set the referenced list
Parameters:
referencedList - if dataType is a (multi) select list, set the referenced list the property itself, useful for chained calls |
| setReferencedType | | public FxPropertyEdit setReferencedType(FxType referencedType)(Code) | | If this propery is a reference to a FxType, set the referenced type
Parameters:
referencedType - if dataType is reference this is the referenced type the property itself, useful for chained calls |
| setSearchable | | public FxPropertyEdit setSearchable(boolean searchable)(Code) | | Set if this property be used in the visual query editor (UI hint)
Parameters:
searchable - property can be used in the visual query editor the property itself, useful for chained calls |
| setUniqueMode | | public FxPropertyEdit setUniqueMode(UniqueMode uniqueMode)(Code) | | Set the uniqueness mode of this property
Parameters:
uniqueMode - uniqueness mode the property itself, useful for chained calls |
| setUseHTMLEditor | | public FxPropertyEdit setUseHTMLEditor(boolean useHTMLEditor)(Code) | | Set if to use an HTML editor to edit values of this property?
Parameters:
useHTMLEditor - use HTML editor to edit values of this property? the property itself, useful for chained calls |
|
|