Package org.compiere.model

Class MStyle

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_Style

org.compiere.model.MStyle

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_AD_Style, I_Persistent, Evaluatee, ImmutablePOSupport

public class MStyle
extends X_AD_Style
implements ImmutablePOSupport

CSS Style model

Author:

hengsin

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SCLASS_PREFIX
static final String	ZCLASS_PREFIX

Fields inherited from class org.compiere.model.X_AD_Style

ENTITYTYPE_AD_Reference_ID

Fields inherited from class org.compiere.model.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, m_attachment, m_idOld, m_IDs, m_KeyColumns, m_optimisticLockingColumns, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_Style

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Style_ID, COLUMNNAME_AD_Style_UU, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_Description, COLUMNNAME_EntityType, COLUMNNAME_IsActive, COLUMNNAME_IsWrapWithSpan, COLUMNNAME_Name, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MStyle(Properties ctx, int AD_Style_ID, String trxName)
MStyle(Properties ctx, String AD_Style_UU, String trxName)	UUID based Constructor
MStyle(Properties ctx, ResultSet rs, String trxName)
MStyle(Properties ctx, MStyle copy)	Copy constructor
MStyle(Properties ctx, MStyle copy, String trxName)	Copy constructor
MStyle(MStyle copy)	Copy constructor

Method Summary

Modifier and Type	Method	Description
String	buildStyle(String defaultTheme, Evaluatee evaluatee)	Build inline CSS style text from lines
String	buildStyle(String defaultTheme, Evaluatee evaluatee, boolean inline)	Build CSS style text from lines
static MStyle	get(int AD_Style_ID)	Get MStyle from cache (immutable)
static MStyle	get(Properties ctx, int AD_Style_ID)	Get MStyle from cache (immutable)
MStyleLine[]	getStyleLines()	Get lines
static boolean	isSClass(String style)
static boolean	isZClass(String style)
MStyle	markImmutable()	mark PO as immutable
static String	parseVariables(String styleText, Evaluatee evaluatee)	Replace @variable@ in style text with the value provided by the evaluatee.

Methods inherited from class org.compiere.model.X_AD_Style

get_AccessLevel, getAD_Style_ID, getAD_Style_UU, getDescription, getEntityType, getName, initPO, isWrapWithSpan, setAD_Style_ID, setAD_Style_UU, setDescription, setEntityType, setIsWrapWithSpan, setName, toString

Methods inherited from class org.compiere.model.PO

afterDelete, afterInsertWithValues, afterSave, beforeDelete, beforeSave, buildInsertSQL, buildInsertSQL, buildUpdateSQL, buildUUIDSubquery, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, doOrganizationCheckForSave, doVerificationForDelete, doVerificationForSave, dump, dump, equals, firePostDeleteEvent, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_deleteStatement, get_deleteTranslationsSQL, get_deleteTreeSQL, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_QueryTimeout, get_Table_ID, get_TableAttribute, get_TableAttributeAsBoolean, get_TableAttributeAsInt, get_TableAttributes, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_ColumnLoaded, is_hasCustomTree, is_Immutable, is_new, is_Partial, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isCrossTenantSafe, isLogSQLScript, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lobSave, lock, makeImmutable, postDelete, resetStateAfterDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveFinish, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnLoaded, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_DocumentNoForNewRecord, set_IDForNewRecord, set_OptimisticLockingColumns, set_Partial, set_QueryTimeout, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_UUIDForNewRecord, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueForNewRecord, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, setupDeleteActionsForTransactionEvent, toInsertSQL, unlock, update_Tree, validForeignKeys, validForeignKeysEx

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_AD_Style

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Field Details

SCLASS_PREFIX

public static final String SCLASS_PREFIX

See Also:

• Constant Field Values

ZCLASS_PREFIX

public static final String ZCLASS_PREFIX

See Also:

• Constant Field Values

Constructor Details

MStyle

public MStyle(Properties ctx,
 String AD_Style_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

AD_Style_UU - UUID key

trxName - Transaction

MStyle

public MStyle(Properties ctx,
 int AD_Style_ID,
 String trxName)

Parameters:

ctx -

AD_Style_ID -

trxName -

MStyle

public MStyle(Properties ctx,
 ResultSet rs,
 String trxName)

Parameters:

ctx -

rs -

trxName -

MStyle

public MStyle(MStyle copy)

Copy constructor

Parameters:

copy -

MStyle

public MStyle(Properties ctx,
 MStyle copy)

Copy constructor

Parameters:

ctx -

copy -

MStyle

public MStyle(Properties ctx,
 MStyle copy,
 String trxName)

Copy constructor

Parameters:

ctx -

copy -

trxName -

Method Details

get

public static MStyle get(int AD_Style_ID)

Get MStyle from cache (immutable)

Parameters:

AD_Style_ID -

Returns:

MStyle

get

public static MStyle get(Properties ctx,
 int AD_Style_ID)

Get MStyle from cache (immutable)

Parameters:

ctx -

AD_Style_ID -

Returns:

MStyle

getStyleLines

public MStyleLine[] getStyleLines()

Get lines

Returns:

array of style line

buildStyle

public String buildStyle(String defaultTheme,
 Evaluatee evaluatee)

Build inline CSS style text from lines

Parameters:

defaultTheme -

evaluatee -

Returns:

CSS style text

buildStyle

public String buildStyle(String defaultTheme,
 Evaluatee evaluatee,
 boolean inline)

Build CSS style text from lines

Parameters:

defaultTheme -

evaluatee - evaluatee for display logic and for the substitution of @variable@ in inline style text (use '@@' for a literal '@')

inline - true for inline (for style="..." use), false for css (for class="..." use)

Returns:

CSS style text

parseVariables

public static String parseVariables(String styleText,
 Evaluatee evaluatee)

Replace @variable@ in style text with the value provided by the evaluatee.

• The SCLASS_PREFIX and ZCLASS_PREFIX prefix is not parsed.
• '@' characters must be paired, '@@' is the escape for a literal '@'. Text with an odd number of '@' is returned as is (logged at FINE level).
• Variable that can't be resolved is kept as is.

Parameters:

styleText -

evaluatee -

Returns:

style text with variables replaced

isSClass

public static boolean isSClass(String style)

Parameters:

style -

Returns:

true if style start with SCLASS_PREFIX (case insensitive)

isZClass

public static boolean isZClass(String style)

Parameters:

style -

Returns:

true if style start with ZCLASS_PREFIX (case insensitive)

markImmutable

public MStyle markImmutable()

Description copied from interface: ImmutablePOSupport

mark PO as immutable

Specified by:

markImmutable in interface ImmutablePOSupport

Returns:

PO